Cards

List cards

Cursor-paginated, scoped to the token's account and role.

Besides the filter[<field>_<predicate>] fields, these filters take a plain value:

  • filter[archived] — false (default) hides archived cards, true returns only archived ones, all returns both. Deleted cards are never listed.
get/v1/cards

Request

  • Base URL: https://api.topkey.io
  • URL: https://api.topkey.io/v1/cards
  • Auth: HTTP bearer

Query parameters

page[size]integer

Rows per page (max 100).

page[after]string

Opaque cursor from the previous page's meta.next_cursor.

archivedstring

false (default) hides archived cards, true returns only archived ones, all returns both. Deleted cards are never listed.

filter[field_predicate]=value (Ransack, per-resource allowlist), and the plain-value filters listed. Unknown filters return 400. Filterable fields: card_type, cardholder_id, created_at, id, integration_key, status, updated_at.

Comma-separated relationships to sideload into included.

Response

A page of cards.

Changes

No recorded changes to this operation across all 1 revision of this API.