Pagination

Most list endpoints in the Publisher API use cursor-based pagination. Each response includes a page object with the information needed to fetch the next set of results.

Request

{
  "pagination": {
    "limit": 100,
    "cursor": null
  }
}

Field	Type	Description
limit	integer	Maximum number of results to return (min: 1, default: 500)
cursor	string | null	Opaque cursor from a previous response. null or omitted for the first page
skip	integer	Number of results to skip (min: 1). Use sparingly - cursor-based iteration is preferred

Response

Every list response includes a page object:

{
  "data": [...],
  "page": {
    "page_size": 100,
    "cursor": "eyJpZCI6Im1fMTIzNCJ9",
    "more": true
  }
}

Field	Type	Description
page_size	integer	Number of results in this page
cursor	string | null	Cursor to pass in the next request. null if no more results
more	boolean	Whether more results are available beyond this page

To retrieve all results, pass the cursor from each response into the next request until cursor is null or more is false.

Sorting

Some list endpoints support a sorts array to control result ordering:

{
  "sorts": [
    { "key": "created_at", "direction": "desc" }
  ]
}

Field	Type	Description
key	string	The field to sort by (e.g. "id", "created_at")
direction	string	"asc" (default) or "desc"

Available sort keys vary by endpoint. Refer to the API reference for details.