Sign in to run requests with your own sandbox key. Sign in

PaginatedMeta

Type: Meta

PaginatedMeta has 6 top-level fields; request_id, page, per_page, total_count, total_pages, object are always present. Fields typed as another schema link to that schema's page, and nested objects expand in place below. It is referenced by 8 operations, listed under Used by. The machine-readable definition is #/components/schemas/PaginatedMeta in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

  • request_id string required Correlation id for this request. Also sent as the `X-Request-Id` response header; quote it when contacting support.
  • page integer required
  • per_page integer required
  • total_count integer required
  • total_pages integer required
  • object string required The object type of every item in `data`.

Used by

Was this page helpful?