List

Paginated list response containing items and pagination metadata.

  • object
    Type: string

    Resource type identifier, always "list"

  • items
    Type: array object[]

    Array of items in the current page

    Empty object
  • pages
    Type: object ยท PageMeta

    Pagination metadata for list responses. Supports both offset and cursor pagination.

    • object
      Type: stringenum

      Pagination type: "offset" or "cursor"

      values
      • offset
      • cursor
    • cursor
      Type: string

      Current cursor position (cursor pagination only)

    • next_cursor
      Type: string

      Cursor for fetching the next page (cursor pagination only)

    • prev_cursor
      Type: string

      Cursor for fetching the previous page (cursor pagination only)

    • page
      Type: integer

      Current page number, 1-indexed (offset pagination only)

    • total_pages
      Type: integer

      Total number of pages (offset pagination only)

    • total_items
      Type: integer

      Total number of items across all pages

    • limit
      Type: integer

      Maximum number of items per page

    • has_next
      Type: boolean

      Whether more items exist after the current page

    • has_prev
      Type: boolean

      Whether more items exist before the current page

    • direction
      Type: stringenum

      Navigation direction: "next" or "previous"

      values
      • next
      • previous