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
cursor in the response. The integration can use the
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 objects from the full list desired in the response. Default: |
Parameter location varies by endpoint
For endpoints using the HTTP
GET method, these parameters are accepted in the request query string. For endpoints using the HTTP
POST method, 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 |
|array of endpoint-dependent objects||The page, or partial list, or results.|