Getting started

Pagination

List responses use cursor pagination. The current OpenAPI document describes the response envelope; a few request-side details still need API-owner confirmation before we publish stronger contract language.

Response shape

Paginated responses return a data array and a meta.cursor object. The live OpenAPI descriptions for list endpoints say to follow meta.cursor.next for the next page.

{
  "data": [],
  "meta": {
    "cursor": {
      "current": null,
      "prev": null,
      "next": null,
      "count": 0
    }
  }
}

Where it appears

The current spec marks these operations as cursor-paginated: GET /host, GET /link, GET /redirect.

Needs confirmation

API-owner confirmation required. The response contract is visible in the spec, but the request parameter used to pass the next cursor is not currently declared in the OpenAPI parameter list. Do not hard-code a parameter name from this page until the API team confirms it in the spec.

Integration pattern

Read the data array from each response and process it before requesting another page.
Continue only while meta.cursor.next is present.
Keep any filter[...] and sort choices stable across the whole walk.
Make the sync resumable: store the last confirmed cursor or reconcile with a filtered list call after interruption.