Pagination

Pagination is implemented on most list endpoints. When paging through results, you can append a query string to a request URI to specify the desired page and an optional page size.

While the default and maximum page size may vary depending upon the endpoint, the default and the maximum is typically 100 items. Paginated responses will include a top-level meta and links objects to provide context and helpful links for pagination.

Example paginated API response

{
    "meta": {
        "pageSize": 100
        "page": 1
    },
    "links": {
        "first": "/v1/users?page=1&pageSize=100"
        "next": "/v1/users?page=2&pageSize=100"
        "prev": null
        "self": "/v1/users?page=1&pageSize=100"
    }
    "data": [...data]
}