Skip to main content
Some behaviours are not specific to a single endpoint: they follow the same syntax and the same rules across the whole API. This section documents those shared mechanisms once, so that the API Reference pages can stay focused on what is specific to each endpoint.

​
What belongs here

A guide in this section describes a mechanism that:

Is shared

It works the same way on every endpoint that supports it.

Is opt-in per endpoint

Each endpoint declares whether it supports it, and with which keys.
Anything that applies to every request — authentication, versioning, error format, rate limits — is covered in Getting Started and Core concepts instead.
This section grows with the API.

​
How to read these guides

Each guide describes the syntax of a mechanism: the shape of the request properties, the accepted values, and the errors returned when something is wrong. The API Reference page of the endpoint you are calling declares how the endpoint opts into the mechanism: whether it is supported at all, which keys are available, and which value types they expect. On those points, the endpoint page wins over a guide. The guide remains the authority on the shared behaviour itself — the syntax, the values accepted at runtime, and the restrictions the reference schemas do not express. An order object, for example, always needs an explicit direction even though the schemas list it as optional, and a few endpoints accept a single order only. Restrictions of that kind are called out in the guide that documents the mechanism.

​
Available guides

Filters

Narrow down the results returned by .list endpoints.

Order

Sort the results deterministically, with one or several keys.

Pagination

Iterate over large collections with cursor-based pagination.

​
Combining filters, order and pagination

On a .list endpoint that supports all three, filters, orders and pagination are independent and combine freely in the same JSON body. Like every tipee API call, requests are POST with a JSON body (see First steps): Filters are applied first, the remaining entries are sorted, and pagination then walks through that sorted result — which is why explicit orders are recommended as soon as you paginate.