Skip to main content
GET

Authorizations

Authorization
string
header
required

Short-lived access token. Obtain with your api_key.

Query Parameters

take
integer
default:10

Page size, 1–100. Defaults to 10.

Required range: 1 <= x <= 100
skip
integer
default:0

Number of cards to skip. Defaults to 0.

Required range: x >= 0
type
enum<string>

Card form factor.

Available options:
physical,
virtual
status
string

Comma-separated statuses. expired matches cards whose expiry month has passed regardless of status.

userIds
string

Comma-separated user UUIDs the cards are assigned to.

companyAccountIds
string

Comma-separated account UUIDs the cards draw from.

Case-insensitive match against the card name or last four digits.

includeTerminated
boolean

true includes terminated cards when no status filter is given.

sort
enum<string>

unactivatedFirst lists pending cards before the rest.

Available options:
unactivatedFirst

Response

Paginated card collection.

data
Card · object[]
required

Cards for the current page.

meta
object
required