Pagination

All list endpoints return paginated results. Control pagination using query parameters or headers:

  • page: Page number (defaults to 1)
  • per_page: Results per page (defaults to 15)

Response Metadata

Paginated responses include a meta object with:

FieldDescription
current_pageCurrent page number
per_pageNumber of results per page
total_countTotal number of records
total_pagesTotal number of pages

Example Response

{
  "data": [
    {
      "id": "123",
      "name": "Example Item 1"
    },
    {
      "id": "124",
      "name": "Example Item 2"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 15,
    "total_count": 42,
    "total_pages": 3
  }
}

On this page