Pagination

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. Defaults to `1`.
page_size	Number of items per page. Defaults to `20`, with a maximum of `200`. A value above the maximum is treated as `200`, and a value below `1` as `1`.

{
	page: 1,
	page_size: 10
}

Here’s an example query string /api/v1/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:

{
  "data": [...],
  "info": {
    "items": 10,
    "page_size": 10,
    "total_items": 15,
    "current_page": 1,
    "next_page": 2,
    "previous_page": null,
    "total_pages": 2
  }
}

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

Filtering

List endpoints take filters as filter[field][comparator]=value, for example /api/v1/projects?filter[name][contains]=Kiln. Each endpoint’s reference page lists the fields and comparators it accepts. A filter the endpoint does not accept returns 400 with a message naming the problem: an unknown field, a comparator the field does not support, a filter parameter that is not in the filter[field][comparator] shape, or a value that cannot be read as the field’s type.

{
  "errors": [
    { "message": "Unsupported comparator 'zz' for filter 'name'. Supported comparators: eq, neq, gt, geq, lt, leq, contains." }
  ]
}

Getting Started

API Cookbooks

Production Data

Accounting and Reporting

Credit Inventory Management

Account Admin

Filtering

​Filtering

Filtering