Pagination

All top-level entities exposed by the Orbiit API have support for pagination. We employ cursor-based pagination throughout, all endpoint support limit, search, and sort, and for pagination we will accept the cursor to denote the starting point of the data that gets returned.

Parameters

All endpoints support the following fields, they are all optional, but some have defaults.

limit	Defines the maximum number of results to include in a single page. The default value for this is 30
search	A term used to further refine results after all filters have been applied. Depending on the endpoint, the term may be applied to multiple string-like fields. Terms are case-insensitive.
sortDirection	Direction to sort in. This is provided a string value that has to be either "ASC" or "DESC". The default value is "DESC" which will return the most recent data first.

Depending on the direction of your search, one of the following pairs of parameters may also be supplied. Both are completely optional, and can be supplied independently of one another if you so wish.

cursor	A cursor used to divide the search domain. Using after will instruct the pager to ignore records that are located before it.

Response format

results	An array containing the nodes found given the supplied paging instructions.
pageInfo	An object containing information relating to the current page.
pageInfo.hasNextPage / pageInfo.hasPreviousPage	A boolean indicating whether or not there is a page before or after the current page respectively.
pageInfo.startCursor / pageInfo.endCursor	A cursor representing the first and last elements in the results array respectively. If the results array is empty, an empty string will be returned.