PaginatedResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/frihet-io/json-schema/frihet-io-paginated-response-schema.json",
  "title": "PaginatedResponse",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/frihet-io-channels-api-openapi.yml#/components/schemas/PaginatedResponse",
  "type": "object",
  "properties": {
    "data": {
      "type": "array",
      "items": {}
    },
    "total": {
      "type": "integer",
      "description": "Total number of items matching the query"
    },
    "limit": {
      "type": "integer",
      "description": "Number of items per page"
    },
    "offset": {
      "type": "integer",
      "description": "Current offset"
    },
    "nextCursor": {
      "type": "string",
      "description": "Cursor for fetching the next page of results. Only present when there\nare more results available. Pass this value as the `cursor` query parameter\nin the next request. Base64url-encoded.\n"
    },
    "truncated": {
      "type": "boolean",
      "description": "Only present (and `true`) when the underlying search query\nsaturated the internal 500-document cap. `total` therefore reports\nthe size of the first 500 matches, not the full match count.\nNarrow the search query (taxId / fiscal id, exact email) to ensure\nyou see every result.\n"
    }
  }
}