Skip to main content
List endpoints (workspaces, products, items, etc.) are paginated. This page covers the API contract; for strategies and code examples, see Pagination.

​
Query Parameters

ParameterTypeDefaultDescription
limitinteger50Number of items per page (1–200)
offsetinteger0Number of items to skip from the start
  • limit: Min 1, max 200. Values outside this range are invalid (typically 422).
  • offset: Min 0. Use offset = 0 for the first page, then offset = limit for the next, and so on.

​
Request Examples

# First page (default: 50 items)
GET /v1/public/workspaces

# First page, 20 items
GET /v1/public/workspaces?limit=20&offset=0

# Second page (items 21–40)
GET /v1/public/workspaces?limit=20&offset=20

​
Response Shape

Paginated list responses always use this structure: 
{
  "items": [
    { "id": "...", "name": "...", ... },
    { "id": "...", "name": "...", ... }
  ],
  "count": 2
}
  • items: Array of resources for the current page.
  • count: Number of items in this response (i.e. items.length), not the total number of resources across all pages.
There is no total field. To fetch all pages, keep requesting with increasing offset until you receive fewer items than limit (or zero). See Pagination for full examples in Python and JavaScript.

​
Which Endpoints Are Paginated?

Any list endpoint that returns a collection (List workspaces, List products, List items, List properties) supports limit and offset. Single-resource endpoints (e.g. get workspace by ID) do not use pagination.