List cards

Returns a list of all cards linked to the account.

By default, GET /cards returns cards ordered by the latest updatedAt. You can combine the different filters as documented.

Use networkBulkFeedId to filter the list to cards enrolled through a given network bulk feed. An unknown feed id returns an empty page. It combines with expand=cardholder.

Use expand=cardholder to embed each card's cardholder under _embedded in the same response instead of calling GET /cards/{cardId}/cardholder per item. The embedded body is the exact body that endpoint serves and requires its cardholder:read scope. Pagination links preserve expand like any other parameter.

This endpoint supports offset-based pagination.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

The card country of issuance following ISO 3166 alpha-3

Allowed:
integer
1 to 12

The card expiration month

integer

The card expiration year

uuid
uuid
expand
array of strings

Embed the card's related cardholder resource under _embedded so one call returns the card
together with its cardholder instead of a follow-up GET /cards/{cardId}/cardholder.

  • cardholder embeds the cardholder exactly as GET /cards/{cardId}/cardholder serves it and
    requires the cardholder:read scope.

A request asking to expand a resource its credentials cannot read is refused with 403
(Missing scope 'cardholder:read'). When the cardholder does not exist (for example a card that
was not bulk-enrolled), the cardholder key is absent from _embedded; _links are unchanged.

Send expand=cardholder. A repeated expand key, an empty value or an unknown value is refused
with 400.

expand
Allowed:
integer
1 to 100
Defaults to 25

Maximum number of items to return

number
Defaults to 0

The offset to use for pagination. Identifies the position of the first item returned in the collection

Headers
string
enum
Defaults to application/hal+json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/hal+json
application/problem+json