Get custom object

Use this endpoint to return one custom object.

important

Custom Objects is currently in early access. Your workspace must be enabled before the Custom Objects API key permissions appear on Settings > API Keys.

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}/{external_id} endpoint.

Example request

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

Sample request payload

Use this JSON object as a reference for the path parameters in this request.

1
2
3
4
{
  "type_name": "account",
  "external_id": "acct-123"
}

Sample cURL request

This example retrieves the acct-123 account record and its stored attributes.

1
2
curl --location --request GET 'https://rest.iad-01.braze.com/custom_objects/objects/account/acct-123' \
--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
{
  "custom_object": {
    "type_name": "account",
    "external_id": "acct-123",
    "attributes": { "name": "Acme", "industry": "software" }
  }
}

Response parameters

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

Errors

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