カスタムオブジェクト一覧

このエンドポイントを使用して、特定のカスタムオブジェクトタイプのオブジェクトを一覧表示します。

重要

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

前提条件

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

レート制限

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

パスパラメーター

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

クエリパラメーター

次の表は、/custom_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/custom_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
}

レスポンスパラメーター

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

エラー

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