Pagination

When querying for a list of objects, you will receive a format like this:


Copy
{
  "total": 15646,
  "list": [
    {
      "id": "bd4a0997-39db-41d9-883a-cdfa83e2101f",
      ...
    },
    ...
  ]
}

Where total is the total number of objects that are available and list is the list of objects that are returned.

Parameters

Parameter	Type	Default	Description
`limit`	`number`	`1000`	The maximum number of objects to return per request. Must be between 1 and 1000.
`offset`	`number`	`0`	The number of objects to skip before returning results. Use this to paginate through large result sets.

The default limit is 1000 objects per request, which is also the maximum. You can use the limit parameter to request fewer objects per request.

For example, to retrieve only 10 objects:

GET /tickets?limit=10

If the total number of objects exceeds the limit, you can use the offset parameter to paginate through the results.

For example, if you have 2500 objects and use the default limit of 1000:

You can combine limit and offset:

GET /tickets?limit=50&offset=100

This returns 50 objects, starting from the 101st object.