Skip to main content
GET
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.
Required headers:
  • Snappy-Account-Id - required for this endpoint.
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 supports brand (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, access card URL, and authentication.method.
  • If authentication.method is accessCode, follow up with GET /v3/digital-cards/{digitalCardId}/access-code to retrieve the code.
  • Cards from other Companies are never returned - the list is scoped to the calling Company.

Authorizations

X-Api-Key
string
header
required

Company Level Authentication

Include your API key in the X-Api-Key header for every request:

Headers

snappy-account-id
string
required

Required. Account identifier.

Example:

"acc123456"

Query Parameters

filter[orderId]
string

Order identifier to retrieve digital cards for.

Minimum string length: 1
Pattern: ^[A-Za-z0-9_-]+$
Example:

"order_123"

page[number]
integer
default:1

1-indexed page number.

Required range: x >= 1
Example:

1

page[size]
integer
default:100

Number of collections per page (max 150, default 100).

Required range: 1 <= x <= 150
Example:

100

include
enum<string>[]

Related entities to include.

Related entities to include.

Available options:
brand
Example:

Response

Paginated list of digital cards.

data
object[]
required

Top-level JSON:API-style pagination links for paginated list responses. first, next, and prev are all required and all nullable. prev is null on cursor-paginated endpoints (backward navigation not supported).

Last modified on September 2, 2026