Lister les relations utilisateur

Utilisez cet endpoint pour lister les utilisateurs liés à un objet de données.

Important

Les objets de données sont actuellement en accès anticipé. Votre espace de travail doit être activé avant que les permissions de clé API pour les objets de données n’apparaissent dans Paramètres > Clés API.

Prérequis

Pour utiliser cet endpoint, vous aurez besoin d’une clé API avec la permission data_objects.user_relationships.read.

Limite de débit

Cet endpoint fait partie du compartiment de lecture des objets de données avec une limite par défaut de 50 requêtes par minute.

Paramètres de chemin

Le tableau suivant liste et décrit les paramètres de chemin pour l’endpoint /data_objects/objects/{type_name}/{external_id}/user_relationships.

Paramètres de requête

Le tableau suivant liste et décrit les paramètres de requête pour l’endpoint /data_objects/objects/{type_name}/{external_id}/user_relationships.

Exemple de requête

Cette section comprend un exemple de payload et un exemple de requête cURL.

Exemple de payload de requête

Utilisez cet objet JSON comme référence pour les paramètres de requête.

1
2
3
4
5
6
7
{
  "type_name": "account",
  "external_id": "acct-123",
  "rel_kind": "account_user",
  "limit": 100,
  "offset": 0
}

Exemple de requête cURL

Cet exemple liste les utilisateurs liés à acct-123 via la relation 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'

Réponse

Cette section comprend un exemple de réponse réussie et les champs de la réponse.

Exemple de réponse réussie

Le code de statut 200 peut renvoyer le corps de réponse suivant.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
{
  "items": [
    {
      "type_name": "account",
      "external_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
}

Le payload user contient uniquement braze_id.

Paramètres de réponse

Le tableau suivant liste et décrit les champs d’une réponse réussie.

Erreurs

Le tableau suivant liste les erreurs courantes pour cet endpoint et comment les résoudre.