Skip to main content
GET

Authorizations

Authorization
string
header
required

Short-lived access token. Obtain with your api_key.

Query Parameters

status
string

Comma-separated card statuses. Defaults to every status except expired and terminated.

type
enum<string>

Card type.

Available options:
virtual,
physical
user_ids
string

Comma-separated UUIDs of the cardholders (max 100).

account_ids
string

Comma-separated UUIDs of the accounts the cards spend from (max 100).

tokens
string

Comma-separated card tokens (max 100).

q
string

Case-insensitive match on card name or last four digits (max 100 characters).

sort
enum<string>

inactive_first lists inactive cards before the rest. Defaults to newest first.

Available options:
inactive_first
limit
integer

Page size, 1–200. Defaults to 50.

Required range: 1 <= x <= 200
cursor
string

next_cursor from the previous page. Cannot be combined with offset.

offset
integer

Number of cards to skip. Cannot be combined with cursor.

Required range: x >= 0

Response

A page of cards.

cards
Card · object[]
required
next_cursor
string

Pass as cursor for the next page. Absent on the last page and when paging by offset.

total
integer

Total matching cards. Only when paging by offset.

total_inactive
integer

Matching cards still inactive. Only when paging by offset.