The pagination feature allows you to retrieve a subset of resources from the API. This is useful when you have a large number of resources and you want to retrieve them in smaller chunks.

These list API methods share a common set of parameters that allow you to control the number of items returned and the page number. For example, you can:

Parameters

page
string
default:
"1"

The page number to retrieve. By default, the first page is returned.

limit
string
default:
"100"

The number of items to retrieve per page. The default value varies by endpoint.

Here is how pagination response data looks like:

{
  "pageInfo": {
    "page": 1,
    "pages": 10,
    "total": 100,
    "pageTotal": 10,
    "hasNextPage": true,
    "hasPrevPage": false
  }
}

Example

The following example demonstrates how to retrieve the first page of 10 links: