Paginating responses

If a collection resource represents a large enough number of resource instances, it does not include them all in a single response. You can apply pagination to break up the results of the JSON response into one or more pages of data. You can request additional pages as separate requests.

To control pagination, use the following optional query parameters:

Parameter name	Type	Description	Example
`offset`	number (The default is `0`)	The zero-based starting index in the entire collection of the first item to return.	`10`
`limit`	number (default: `10`, minimum: `1`, maximum:`100`)	The maximum number of collection items to return for a single request.	`40`

Parameter name

Type

Description

Example

offset

number

(The default is 0)

The zero-based starting index in the entire collection of the first item to return.

10

limit

number

(default: 10, minimum: 1, maximum:100)

The maximum number of collection items to return for a single request.

40

If you have suggestions for improving this article, let us know!