List cards
OAuth scope: card.read
Retrieves the list of cards that can be viewed by the authenticated membership.
You can filter and sort this list by using query parameters 👇
This endpoint is still in beta. Please get in touch with our team if you have any question or feedback: here.
Authorizations
Bearer authorization header: Bearer <token>
, where <token>
is the access token received from the authorization server at the end of the OAuth 2.0 flow.
Headers
Required only for Sandbox API requests; to get one, please sign up to the Developer Portal.
Query Parameters
Text search can be performed on the following fields:
- memberships.first_name
- memberships.last_name
- cards.id
- cards.nickname
- cards.last_digits
- cards.status
- cards.pre_expires_at
- cards.exp_year
- cards.exp_month
Returned page (cf. Pagination).
2
Cards can be sorted by a specific property and order.<br>👉 Property: status
, nickname
, last_activity_at
or created_at
<br>👉 Order: asc
(Ascending) / desc
(Descending)
Cards can be filtered by their holder_id
.
The membership identifier of the card holder.
Cards can be filtered by their status
.
"statuses[]=pending&statuses[]=live"
Cards can be filtered by their bank_account_id
.
The id of the bank account to which the card is attached
"bank_account_ids[]=id1&bank_account_ids[]=id2"
Cards can be filtered by their card_level
.
"card_levels[]=virtual&card_levels[]=flash"
Cards can be filtered by their id
.
Unique card identifier
"ids[]=id1&ids[]=id2"
Response
Returns the list of cards.
The response is of type object
.