Skip to content

List custom objects

get

/custom_objects/objects/{type_name}

Use this endpoint to list objects for a specific custom object type.

Prerequisites

To use this endpoint, you need an API key with custom_objects.read.

Rate limit

This endpoint is in the Custom Objects read bucket with a default limit of 50 requests per minute.

Path parameters

The following table lists and describes the path parameters for the /custom_objects/objects/{type_name} endpoint.

Parameter Required Data Type Description
type_name Required String Custom object type machine name

Query parameters

The following table lists and describes the query parameters for the /custom_objects/objects/{type_name} endpoint.

Parameter Required Data Type Description
search_term Optional String Substring filter on object identifier
limit Optional Integer Page size. Default 100. Clamped to 1 through 250
offset Optional Integer Offset. Default 0. Negative values are floored to 0

Example request

This section includes a sample parameter payload and a sample cURL request.

Sample request payload

Use this JSON object as a reference for request parameters.

1
2
3
4
5
6

{
  "type_name": "account",
  "search_term": "acct",
  "limit": 100,
  "offset": 0
}

Sample cURL request

This example lists the account records matching the search term acct, returning the first page of results.

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'

Response

This section includes a sample successful response and the response fields.

Example success response

The status code 200 could return the following response body.

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
}

Response parameters

The following table lists and describes the fields in a successful response.

Parameter Required Data Type Description
items Required Array List of custom object records
items[].type_name Required String Custom object type machine name
items[].external_id Required String Custom object identifier
items[].attributes Required Object Object attributes keyed by field name
total_count Required Integer Total number of matching records
has_more Required Boolean Whether another page of results is available
next_offset Optional Integer Offset for the next page when has_more is true
offset Required Integer Current page offset
limit Required Integer Page size used by the request

Errors

The following table lists common errors for this endpoint and how to resolve them.

Status Cause Guidance
404 Type not found (custom-object-type-not-found) Confirm type_name exists in the workspace and matches the machine name exactly.
401 Missing or invalid REST API key Verify the Authorization header uses Bearer YOUR_REST_API_KEY and that the key is active.
403 API key lacks permission or request is blocked by allowlist Confirm the key has custom_objects.read and that your source IP is on the key allowlist, if configured.
429 Rate limit exceeded Retry after X-RateLimit-Reset and reduce request frequency.
New Stuff!