When an API response contains an array of records, it will also include a pagination object when the total number of records exceeds the request limit.

By default, this limit is set to 20, but you can modify it by specifying a value in the ‘limit’ query parameter when making the request.

Please note that the maximum allowed value for ‘limit’ is 100.

You can leverage the pagination object to make subsequent requests and retrieve all the records.

The structure of the pagination object is illustrated in the following example:

  "meta": {
    "page": 1, // Current page
    "limit": 20, // Number of records per page
    "total": 250 // Total number of records