ユーザーリレーションシップの一覧

このエンドポイントを使用して、1つのデータオブジェクトにリンクされたユーザーを一覧表示します。

重要

データオブジェクトは一般提供されていますが、このエンドポイントを使用する前に、ワークスペースでアカウントのプロビジョニングが完了している必要があります。プロビジョニングをリクエストするには、データ設定 > アカウントに移動し、アンケートに回答してください。詳細については、アカウントを有効にするを参照してください。

前提条件

このエンドポイントを使用するには、data_objects.user_relationships.read 権限を持つ API キーが必要です。

レート制限

このエンドポイントはデータオブジェクトの読み取りバケットに含まれ、デフォルトの制限は1分あたり1000リクエストです。

パスパラメーター

以下の表は、/data_objects/objects/{type_name}/{object_id}/user_relationships エンドポイントのパスパラメーターの一覧と説明です。

クエリパラメーター

以下の表は、/data_objects/objects/{type_name}/{object_id}/user_relationships エンドポイントのクエリパラメーターの一覧と説明です。

リクエスト例

このセクションには、サンプルパラメーターペイロードとサンプル cURL リクエストが含まれています。

サンプルリクエストペイロード

リクエストパラメーターの参考として、以下の JSON オブジェクトを使用してください。

1
2
3
4
5
6
7

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

サンプル cURL リクエスト

この例では、account_user リレーションシップを通じて acct-123 にリンクされたユーザーを一覧表示します。

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'

レスポンス

このセクションには、成功レスポンスのサンプルとレスポンスフィールドが含まれています。

成功レスポンスの例

ステータスコード 200 は、以下のレスポンスボディを返す可能性があります。

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
}

user ペイロードには braze_id のみが含まれます。

レスポンスパラメーター

以下の表は、成功レスポンスに含まれるフィールドの一覧と説明です。

エラー

以下の表は、このエンドポイントで発生する一般的なエラーとその解決方法の一覧です。