Pagination

Pagination and no-pagination considerations

Today, Each paginated API call is limited to returning 12000 rows. To get more results, use the pagination capability of the APIs.


ℹ️

Pagination versions

The following APIs currently support pagination:

When using pagination, note the version and the pagination mechanism used by the relevant API.


To use pagination add an additional parameter called token to the query parameters. You do not need to attach token for the first call.

In the response of the relevant calls, you will find a field called nextToken, use it in the next request.

In order to get the full data (in case nextToken is not null), make the same API request with token=nextToken value until nextToken returns with a null value.

{ 
  "data": "[item1, item2, … , item5000]",
   "nextToken": 2 
}
{ 
  "data": "[item5001, item5002, … , item6000]",
   "nextToken": null 
}
❗️

No-pagination APIs

The APIs that do not support pagination, allow up to 500K records in the response.

If the expected number of records is over 500K, you will receive HTTP response code 206 and the first 500K records.