Pagination
Pagination information is included in the Link
header. It is important to follow these Link header values instead of constructing your own URLs since the pagination method can differ between resources.
The URL for pagination is shown inside angled brackets, and the type of pagination link is described in the rel field:
Results per page
Requests that return multiple items will be paginated to 30 items by default. For some resources, you can also set a custom page size up to 100 with the per_page
parameter:
The per_page
maximum for certain resources is lower. This will be specified in the API reference for the endpoint. If a per_page
value greater than a given endpoint's maximum value is supplied, only results up to the maximum will be returned.
Total count of results
Most requests that return multiple items will also include an X-Total-Count
header with the count of all results: