v29

latestOpenAPI 3.0.3raw.githubusercontent.com2026-05-13511526891.2 KB
Custom Object Records

List Custom Object Records

Lists all undeleted custom object records for the specified object

Pagination

  • Cursor pagination only.

Allowed For

  • Agents
get/api/v2/custom_objects/{custom_object_key}/records

Path parameters

custom_object_keystring required

The key of a custom object

Query parameters

filter[ids]string

Optional comma-separated list of ids to filter records by. If one or more ids are specified, only matching records are returned. The ids must be unique and are case sensitive.

filter[external_ids]string

Optional comma-separated list of external ids to filter records by. If one or more ids are specified, only matching records are returned. The ids must be unique and are case sensitive.

sortstring

One of id, updated_at, -id, or -updated_at. The - denotes the sort will be descending.

page[before]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.before_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[after]string

A pagination cursor that tells the endpoint which page to start on. It should be a meta.after_cursor value from a previous request. Note: page[before] and page[after] can't be used together in the same request.

page[size]integer

Specifies how many records should be returned in the response. You can specify up to 100 records per page.

Response

Success response

countinteger

The number of results returned for the current request