Start typing to search.

API Reference

Pagination

View Markdown

Pagination parameters and response envelopes defined by the API.

Pagination is endpoint-specific. Use only the parameters documented on the endpoint you are calling.

Pagination parameters

  • cursorstring Pagination cursor from a previous response
  • limitinteger Maximum number of results to return Example: 50
    • Default: 50
    • Maximum: 200

Pagination response schemas

PaginatedResult

  • Reference: PaginatedResult
    • Type: object
    • Properties:
      • result (array<unknown>)
        • Items:
          • Type: unknown
      • nextCursor (string | null)
        • Nullable: yes
      • prevCursor (string | null)
        • Nullable: yes
      • total (integer) — Total number of records matching the current filters

When a response includes a next cursor, pass it unchanged to the endpoint’s cursor parameter. Stop when no next cursor is returned.