Skip to main content
GET
List cards

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
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.