Get digital card by ID
Digital Cards
Get digital card by ID
Use this endpoint to retrieve a single digital card by its stable ID.
Required parameters:
digitalCardId- the digital card identifier, passed as a path parameter.
Optional query parameters:
include- related entities to expand. Currently supportsbrand(returns full brand details on the digital card).
Behavior notes:
- Returns the digital card’s redemption URL and
authentication.method(OTPoraccessCode). - Returns
404if the digital card does not exist or belongs to a different Company.
Permissions:
- Requires:
digital-card:read
Permissions
- Requires:
digitalCards:read
GET
Get digital card by ID
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"
Path Parameters
The unique identifier of the digital card to retrieve.
Minimum string length:
1Pattern:
^[A-Za-z0-9_-]+$Example:
"digital_card_123"
Query Parameters
Related entities to include.
Related entities to include.
Available options:
brand Example:
Response
Digital card object.
Digital card.
Last modified on July 30, 2026