Skip to main content
GET
List cards

Filter and sort cards

Pass one or more public statuses separated by commas, for example status=active,frozen. Status filters match the status returned on each card, including lifecycle flags and expiry rules. Filter creation or last update time with createdAt[gte], createdAt[lt], updatedAt[gte] and updatedAt[lt]. gte includes its instant; lt excludes it. Either bound can be omitted. A date such as 2026-10-01 means midnight UTC. Timestamps must include Z or a timezone offset. When encoding an offset in a URL, encode + as %2B. For active or frozen cards created during October:
For cards updated since a specific instant:
All supplied filters combine with AND. A card can match any status in the status list. Invalid statuses, malformed ranges, invalid dates, and unsupported sorting return 400. When both bounds are supplied, gte must be strictly before lt. Sort by id, createdAt or updatedAt, optionally followed by :asc or :desc. The default direction is ascending. Timestamp sorts use card ID in the same direction to break ties. Omitting sort preserves the existing ordering. The ordering is deterministic for unchanged data; page/limit pagination does not provide a snapshot when cards change between requests.

Authorizations

x-api-key
string
header
required

Enter your API key

Query Parameters

page
integer
default:1

Which page of results to return, starting at 1 (the default). Use it with meta.totalPages to go through all results.

Required range: 1 <= x <= 9007199254740991
limit
integer
default:20

How many items to return per page. It must be between 1 and 100 (default 20).

Required range: 1 <= x <= 100
status
enum<string>[]

Only return cards with these public statuses. Separate multiple statuses with commas, for example active,frozen.

Available options:
pending,
active,
frozen,
inactive,
expiring,
expired,
terminated
Example:
createdAt
object

Filter creation time. For example, createdAt[gte]=2026-10-01&createdAt[lt]=2026-11-01 includes all of October in UTC. Either bound can be omitted.

Example:
updatedAt
object

Filter last update time. For example, updatedAt[gte]=2026-11-04T08:00:00Z includes cards updated at or after that instant. Either bound can be omitted.

Example:
sort
string

Sort by id, createdAt or updatedAt, optionally followed by :asc or :desc. Default direction is asc. Timestamp sorts also order by id in the same direction. Omit to preserve the existing order.

Pattern: ^(id|createdAt|updatedAt)(:(asc|desc))?$
Example:

"createdAt:desc"

type
enum<string>

Only return virtual or physical cards. Leave it out to get both.

Available options:
virtual,
physical
name
string

Only return cards whose cardholder's name contains this text, ignoring upper and lower case. For example, ada matches Ada Lovelace.

Required string length: 1 - 255
email
string

Only return cards whose cardholder's email contains this text, ignoring case. For example, @marketing.acme.com returns everyone on that domain.

Required string length: 1 - 255
title
string

Only return cards whose nickname contains this text, ignoring case. This works well with a naming convention, for example CMP- for all campaign cards.

Required string length: 1 - 255
last4
string

Only return cards ending in these four digits. Useful when a team member reads out the last digits of their card.

Required string length: 4

Response

items
object[]
required

The cards on this page, one object per card.

meta
object
required

Pagination details, so you know how many results exist and which page you're on.