Skip to content

Custom Object Instances

A paginated list of custom object instances.

typestring

The type of the object - list.

Value:"list"
Example:"list"

The majority of list resources in the API are paginated to allow clients to traverse data over multiple requests.

Their responses are likely to contain a pages object that hosts pagination links which a client can use to paginate through the data without having to construct a query. The link relations for the pages field are as follows.

total_countinteger

A count of the total number of custom object instances.

Example:2
dataArray of objects(Custom Object Instance)

An array of Custom Object Instance objects.

{ "type": "list", "pages": { "type": "pages", "page": 1, "next": "http://example.com", "per_page": 50, "total_pages": 1 }, "total_count": 2, "data": [ {} ] }