The grouping of HTTP endpoints reflects the high-level entities of the Airy Core Data Model.
All HTTP endpoints adhere to the following conventions:
- Endpoints only accept
- We use dots for namespacing URLs (eg
By default, paginated endpoints return a maximum of 20 elements on the first page.
The size of the returned page can be controlled by the
page_size field of the
body. You can move back and forth between pages using the
cursor field of the
Paginated endpoints always respond with the following JSON format:
The response comes in two parts:
An array of objects. Object specification depends on the endpoint.
pagination_dataAn object with the following fields:
The ID of first elements in the previous page of data. Empty if the returned page is the first one.
The ID of first elements in the next page of data. Empty if the returned page is the last one.
The total number of elements across pages in the context of the current filter selection. Only applicable to paginated endpoints that can filter data.
The total number of elements across all pages.