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

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

重要

カスタムオブジェクトは現在、早期アクセス段階です。カスタムオブジェクトのAPIキー権限が設定 > APIキーに表示されるには、ワークスペースが有効になっている必要があります。

前提条件

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

レート制限

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

パスパラメーター

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

クエリパラメーター

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

リクエスト例

このセクションでは、サンプルパラメーターペイロードとサンプルcURLリクエストを紹介します。

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

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

1
2
3
4
5
6
7
{
  "type_name": "account",
  "external_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/custom_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",
      "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
}

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

レスポンスパラメーター

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

エラー

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