Getting Started
Pagination
How collections are paginated in the API.
Endpoints which return collections (e.g. /projects
, /orders
) will return paginated results.
The following parameters can be passed for paginated objects:
Parameter | Meaning |
---|---|
page | Page to return |
page_size | Size of page to return |
Here’s an example query string /api/v0.1/projects?page=1&page_size=10
.
If an object is paginated, the results will be returned in the data
object and pagination information will be returned in the info
object:
Field | Meaning |
---|---|
items | Number of items returned in the results |
total_items | Total number of items across all pages |
current_page | Current page of the request |
next_page | Page number of next page of results |
previous_page | Page number of previous page of results |
total_pages | The total number of pages of results |