Skip to main content
GET
List cards
Required scope: CARDS_READ

Authorizations

Authorization
string
header
required

API key as Bearer token

Headers

Reap-Version
enum<string>
required

API version (YYYY-MM-DD)

Available options:
2025-02-14
Example:

"2025-02-14"

Query Parameters

limit
integer
default:20

Maximum number of items to return (1-100, default: 20)

Required range: x <= 100
Examples:

20

50

100

cursor
string

Opaque cursor for pagination. Pass nextCursor from previous response to get next page.

id
string<uuid>

Filter cards by exact ID match

status
enum<string>[]

Filter cards by status (comma-separated)

  • ACTIVE: Card is active and can be used
  • FROZEN: Card is frozen - the soft toggle a cardholder flips (e.g. a misplaced card). Unfreeze restores it.
  • BLOCKED: Card is blocked. Whether unblock can lift it depends on the block reason; the rest need Reap support.
  • EXPIRED: Card has expired
Available options:
ACTIVE,
FROZEN,
BLOCKED,
EXPIRED
type
enum<string>[]

Filter cards by type (comma-separated)

Available options:
VIRTUAL,
PHYSICAL
physicalCardStatus
enum<string>[]

Filter cards by physical card lifecycle status (comma-separated). Only meaningful for PHYSICAL cards.

Available options:
NOT_ORDERED,
REQUESTED,
IN_PRODUCTION,
PRODUCTION_COMPLETED,
IN_TRANSIT,
OUT_FOR_DELIVERY,
DELIVERED,
ACTIVATED,
CANCELED,
DELIVERY_FAILED,
EXCEPTION
accountId
string<uuid>[]

Filter cards by account ID(s) (comma-separated)

userId
string<uuid>[]

Filter cards by user ID(s) (comma-separated)

includeTotalCount
string

When true, the response includes totalCount, the number of items matching the filters across all pages. Counting adds work to the request, so pass it only on the first page and only when you need it.

Response

200 - application/json

Response for status 200

items
object[]
required
nextCursor
string | null
required

Cursor for next page, or null if no more items

totalCount
integer

Number of items matching the filters across all pages, ignoring cursor and limit. Present only when includeTotalCount=true.

Required range: 0 <= x <= 9007199254740991
Example:

1240