データオブジェクトの一覧取得

このエンドポイントを使用して、特定のデータオブジェクトタイプのオブジェクトを一覧取得します。

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

クエリパラメーター

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

リクエスト例

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

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

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

1
2
3
4
5
6
{
  "type_name": "account",
  "search_term": "acct",
  "limit": 100,
  "offset": 0
}

サンプルcURLリクエスト

この例では、検索語 acct に一致する account レコードを一覧取得し、結果の最初のページを返します。

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/data_objects/objects/account?search_term=acct&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
{
  "items": [
    {
      "type_name": "account",
      "external_id": "acct-123",
      "attributes": { "name": "Acme", "industry": "software" }
    }
  ],
  "total_count": 1,
  "has_more": false,
  "next_offset": null,
  "offset": 0,
  "limit": 100
}

レスポンスパラメーター

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

エラー

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