Skip to main content
GET
List wallet passes

Authorizations

Authorization
string
header
required

Path Parameters

brand_id
string
required

Brand Identifier

program_id
string
required

Program Identifier

Query Parameters

pageSize
number

Page Size max of 2000

pageNumber
number

Page Number

onlyCount
boolean

Retrieve only the count of cards

template_id
number

Template Identifier

template_tier_id
number

Template Tier Identifier

status_code
number

Status Code Filter

status_code_query_type
string

Status Code Query Type, eq, lt, gt, lte, gte

last_updated
string

Last Updated Filter, format: yyyy-MM-ddTHH:mm:ss.SSSZ or time in milliseconds

last_updated_query_type
string

Status Code Query Type, eq, lt, gt, lte, gte

last_updated_start
string

Last Updated Start Date Filter, format: yyyy-MM-ddTHH:mm:ss.SSSZ or time in milliseconds

last_updated_end
string

Last Updated End Date Filter, format: yyyy-MM-ddTHH:mm:ss.SSSZ or time in milliseconds

email
string

Email Address, for backwards compatibility, you should be using the unique_id. Only works if the email address is the unique identifier for the brand.

unique_id
string

External unique identifier for the wallet card (recommended). Must match the value stored in passdata.metaData at issue time, such as memberId.

serial_number
string

Pass Serial Number

pass_ids
array

Pass Serial Number

group_id
string

Group Identifier

Response

200 - application/json

OK

passId
number
serialNumber
string
templateId
number
groupId
string

If provided, this group identifier will be used to group the wallet passes together.

personId
string
templateTierId
number

The optional wallet pass tier identifier for updating the tier on the wallet card.

currentMessage
string

The current message for the wallet pass

passdata
object
downloadUrl
string

The download url for the pass

statusCode
string

The status for the pass

status
number

The numeric representation of the status

workflowTracking
object[]

Workflow execution tracking