List digital cards
Digital Cards
List digital cards
Use this endpoint to retrieve a paginated list of digital cards - typically the first step in retrieving an access code for a digital card that uses accessCode authentication.
Optional query parameters:
filter[orderId]- scope the list to digital cards created for a specific order. Omit to list all digital cards visible to the caller.include- related entities to expand. Currently supportsbrand(returns full brand details on each digital card).page[number]- 1-indexed page number (default 1).page[size]- number of digital cards per page (max 150, default 100).
Behavior notes:
- Returns each digital card’s
digitalCardId, redemption URL, andauthentication.method. - If
authentication.methodisaccessCode, follow up withGET /v3/digital-cards/{digitalCardId}/access-codeto retrieve the code. - Cards from other Companies are never returned - the list is scoped to the calling Company.
Permissions:
- Requires:
digital-card:read
Permissions
- Requires:
digitalCards:read
GET
List digital cards
Authorizations
Company Level Authentication
Include your API key in the X-Api-Key header for every request:
Headers
Optional account identifier for swag validation/filtering.
Example:
"acc123456"
Optional company identifier for swag validation/filtering.
Example:
"cmp123456"
Query Parameters
Order identifier to retrieve digital cards for.
Minimum string length:
1Pattern:
^[A-Za-z0-9_-]+$Example:
"order_123"
1-indexed page number.
Required range:
x >= 1Example:
1
Number of collections per page (max 150, default 100).
Required range:
1 <= x <= 150Example:
100
Related entities to include.
Related entities to include.
Available options:
brand Example:
Response
Paginated list of digital cards.
Last modified on July 30, 2026