Endpoints which return a list of objects use pagination. Pagination allows an integration to request a part of the list, receiving an array of
results and a
next_cursor in the response. The integration can use the
next_cursor in another request to receive the next part of the list. Using this technique, the integration can continue to make requests to receive the whole list (or just the parts the integration needs).
Each paginated endpoint accepts the following request parameters:
The number of items from the full list desired in the response.
The response may contain fewer than this number of results.
Parameter location varies by endpoint
For endpoints using the HTTP
GETmethod, these parameters are accepted in the request query string. For endpoints using the HTTP
POSTmethod, these parameters are accepted in the request body.
Responses from paginated endpoints contain the following properties:
When the response includes the end of the list,
Only available when
Used to retrieve the next page of results by passing the value as the
array of endpoint-dependent objects
The page, or partial list, or results.
Type of the objects in
An object containing a type-specific pagination information.
Responses from paginated endpoints have keys corresponding to the value of
type. Under the key is an object with type-specific pagination information.
"page_or_database" pagination type objects are empty objects. See Property item object endpoint for a description of
"property_item" pagination type object.