ListMeta
Response and request schema
Schema
object
Shared list-envelope fields. Every list response is an object
composed (via allOf) of this schema plus an endpoint-specific
required data array; list results are never a bare JSON array.
total is the exact traversal-start count computed once on the
first page and repeated unchanged on later pages of the same
traversal. There are no page numbers or offset parameters; the
count sizes the job, the token retrieves the next page.
| Field | Type | Description |
|---|---|---|
has_more | boolean · required | Whether at least one further page exists. |
next_page_token | string or null · required | Opaque signed token for the next page, supplied via the |
total | integer (int64) · required | Exact number of items matching the traversal at its start. Stable across the pages of one traversal. Minimum: |
Complete OpenAPI definition
{
"description": "Shared list-envelope fields. Every list response is an object\ncomposed (via `allOf`) of this schema plus an endpoint-specific\nrequired `data` array; list results are never a bare JSON array.\n`total` is the exact traversal-start count computed once on the\nfirst page and repeated unchanged on later pages of the same\ntraversal. There are no page numbers or offset parameters; the\ncount sizes the job, the token retrieves the next page.\n",
"properties": {
"has_more": {
"description": "Whether at least one further page exists.",
"type": "boolean"
},
"next_page_token": {
"description": "Opaque signed token for the next page, supplied via the `page_token` query parameter. `null` exactly when `has_more` is `false`. Bound to the originating query, sort profile, page size and API key, with an expiry.",
"nullable": true,
"type": "string"
},
"total": {
"description": "Exact number of items matching the traversal at its start. Stable across the pages of one traversal.",
"format": "int64",
"minimum": 0,
"type": "integer"
}
},
"required": [
"total",
"has_more",
"next_page_token"
],
"type": "object"
}