Listar relacionamentos de usuários

Use este endpoint para listar os usuários vinculados a um objeto de dados.

Importante

Data Objects está disponível para todos, mas seu espaço de trabalho precisa estar provisionado para Accounts antes que você possa usar este endpoint. Para solicitar o provisionamento, acesse Configurações de dados > Accounts e preencha o questionário. Para mais detalhes, consulte Ativar Accounts.

Pré-requisitos

Para usar este endpoint, você precisa de uma chave de API com a permissão data_objects.user_relationships.read.

Limite de frequência

Este endpoint está no bucket de leitura de Data Objects, com um limite padrão de 1.000 requisições por minuto.

Parâmetros de rota

A tabela a seguir lista e descreve os parâmetros de rota do endpoint /data_objects/objects/{type_name}/{object_id}/user_relationships.

Parâmetros de consulta

A tabela a seguir lista e descreve os parâmetros de consulta do endpoint /data_objects/objects/{type_name}/{object_id}/user_relationships.

Exemplo de requisição

Esta seção inclui um exemplo de carga útil de parâmetros e um exemplo de requisição cURL.

Exemplo de carga útil da requisição

Use este objeto JSON como referência para os parâmetros da requisição.

1
2
3
4
5
6
7

{
  "type_name": "account",
  "object_id": "acct-123",
  "rel_kind": "account_user",
  "limit": 100,
  "offset": 0
}

Exemplo de requisição cURL

Este exemplo lista os usuários vinculados a acct-123 por meio do relacionamento account_user.

1
2

curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/objects/account/acct-123/user_relationships?rel_kind=account_user&limit=100&offset=0' \
--header 'Authorization: Bearer YOUR_REST_API_KEY'

Resposta

Esta seção inclui um exemplo de resposta bem-sucedida e os campos da resposta.

Exemplo de resposta bem-sucedida

O código de status 200 pode retornar o seguinte corpo de resposta.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

{
  "items": [
    {
      "type_name": "account",
      "object_id": "acct-123",
      "rel_kind": "account_user",
      "user": { "braze_id": "507f1f77bcf86cd799439011" },
      "attributes": { "role": "admin" }
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

A carga útil user contém apenas braze_id.

Parâmetros da resposta

A tabela a seguir lista e descreve os campos de uma resposta bem-sucedida.

Erros

A tabela a seguir lista os erros comuns deste endpoint e como resolvê-los.