This chapter contains generally applicable information on API design. When using Ory services, one can expect a consistent experience when interacting with REST APIs.
On REST endpoints that are explicitly labeled as such, pagination information is
available through the
Link HTTP header.
Link header contains a comma-delimited list of links to the following
pages (where applicable):
- Previous (prev)
Pages are created based on the values of
offset provided in the
limit is the page size, and
offset is the current item.
limit parameter always has an API specific upper bound to prevent DoS.
In most scenarios, the
offset should be a multiple of the
You can get the total item count from the
X-Total-Count HTTP Header.
Ory's APIs use rfc3339 as the date format: