Skip to main content

Pagination

Endpoints which use pagination will return a pagination field in the response. This field contains information about the current page, as well as links to the next and previous pages.

Query Parameters

ParameterDescriptionRequired
offsetThe number of items to skip before starting to collect the result setNo
limitThe maximum number of items to returnNo

Response

If a response has pagination, it will be included in the pagination field of the response. Below is an example of the pagination field structure:

{
"success": true,
"data": "<response-data>",
"pagination": {
"limit": 100,
"offset": 0,
"next": "<next-page-url>",
"previous": "<previous-page-url>"
}
}

If there is no next or previous page, the corresponding field will be null.