A collection endpoint returns an index of records. All collection endpoints will return a set of HTTP headers that contain pagination info.

Response HeaderDescription
X-PageThe current page index
X-Per-PageThe number of results per page
X-Total-CountThe total number of records
X-Total-PagesThe total number of pages

A client can also request specific pages through query string parameters.

GET /api/v1/teams/:team_id/purchase_orders?per_page=10&page=3
HTTP/1.1 200 OK
Content-Type: application/json
X-Page: 1
X-Per-Page: 100
X-Total-Count: 131
X-Total-Pages: 2


The default value for per_page is 100 and the max is 1000.