Show Pass

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Pass UUID or External ID

Query Parameters

includePassDesign

boolean

If true, includes the pass design in the response

includeLocations

boolean

If true, includes the locations in the response if any are present

includeBeacons

boolean

If true, includes the beacons in the response if any are present

includePassSource

enum<string>

Used when delivering the pass directly to the passholder, without using PassEntry's download page. Choose one of Apple/Google, includes the pass source in the response. The passSource object is only included if the pass is not currently 'active'

Available options:

apple,

google

Response

200 - application/json

data

object

data.attributes

object

data.attributes.addedAt

string | null

When pass has been added to wallet by the user. In ISO8601 format, UTC

data.attributes.barcode

object | null

If present, the barcode type and value

data.attributes.beacons

object[]

Beacons, present if 'includeBeacons' query param is set to true

data.attributes.createdAt

string

In ISO8601 format, UTC

data.attributes.deactivatedAt

string | null

When pass has been deactivated. In ISO8601 format, UTC

data.attributes.deviceType

enum<string>

Available options:

android,

iphone

data.attributes.downloadUrl

string

Unique download URL of the pass

data.attributes.expiresAt

string | null

Pass will expire at this time. In ISO8601 format, UTC

data.attributes.extId

string | null

Pass External ID

data.attributes.groupTag

string | null

Tag used for grouping passes

data.attributes.latestMessage

string | null

If present, the last push message sent to the pass

data.attributes.locations

object[]

Locations, present if 'includeLocations' query param is set to true

data.attributes.nfc

string | null

If present, the NFC message to be conveyed when the pass is tapped

data.attributes.passContent

object

data.attributes.passDesign

object

Pass design values, present if pass template has been overridden for this pass, or if 'includePassDesign' query param is set to true

data.attributes.passSource

object

Pass source, present if 'includePassDesign' query param is present, one of Apple/Google and current pass status is not 'active'.

data.attributes.passTemplateName

string

Name of corresponding pass template

data.attributes.passTemplateUuid

string

UUID of corresponding pass template

data.attributes.passType

enum<string>

Pass Type

Available options:

generic,

eventTicket,

storeCard

data.attributes.removedAt

string | null

When pass has been removed from wallet by the user. In ISO8601 format, UTC

data.attributes.status

enum<string>

Pass Status

Available options:

issued,

active,

removed,

deactivated

data.id

string

Auto-generated UUID of the pass

data.type

string

Introduction

Entities

Pass Templates

Passes

Readers

Scans

Loyalty

Webhooks

Authorizations

Path Parameters

Query Parameters

Response