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

Successful

data

object

Show child attributes

data.id

string

Auto-generated UUID of the pass

Example:

"e89b1330fc391ec89656f3c664318cff8805471e"

data.type

string

Example:

"pass"

data.attributes

object

Show child attributes

data.attributes.downloadUrl

string

Unique download URL of the pass

data.attributes.passType

enum<string>

Pass Type

Available options:

generic,

eventTicket,

storeCard,

transit

data.attributes.deviceType

enum<string>

Available options:

android,

iphone

data.attributes.createdAt

string

In ISO8601 format, UTC

data.attributes.status

enum<string>

Pass Status

Available options:

issued,

active,

removed,

deactivated

data.attributes.extId

string | null

Pass External ID

data.attributes.groupTag

string | null

Tag used for grouping passes

data.attributes.groupTags

array | null

Tag used for grouping passes

data.attributes.addedAt

string | null

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

data.attributes.removedAt

string | null

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

data.attributes.deactivatedAt

string | null

When pass has been deactivated. In ISO8601 format, UTC

data.attributes.expiresAt

string | null

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

data.attributes.passTemplateUuid

string

UUID of corresponding pass template

data.attributes.passTemplateName

string

Name of corresponding pass template

data.attributes.nfc

string | null

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

data.attributes.barcode

object

If present, the barcode type and value

Show child attributes

data.attributes.barcode.enabled

boolean

Barcode enabled

data.attributes.barcode.type

enum<string>

Barcode type

Available options:

qr,

code128,

aztec,

pdf417

data.attributes.barcode.source

enum<string>

Barcode source

Available options:

uuid,

extId,

custom

data.attributes.barcode.value

string

Barcode value

Example:

"123abcd"

data.attributes.barcode.displayText

boolean

If true, display the barcode value as text on the pass

data.attributes.latestMessage

string | null

If present, the last push message sent to the pass

data.attributes.passContent

object

Show child attributes

data.attributes.passContent.{key}

The templateKey identifies a pass field in the template (using the template field ID). Its value must be an object with a required value string, and may optionally include a localisation object that maps locale codes to translated values.

Example:

{
  "eventName": {
    "value": "Summer Festival",
    "localisation": {
      "es": { "value": "Festival de Verano" },
      "fr": { "value": "Festival d'Été" }
    }
  }
}

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

Show child attributes

data.attributes.passDesign.backgroundColor

string

Pass background color in hex format

Example:

"#EFEFEF"

data.attributes.passDesign.labelColor

string

Pass label color in hex format. Only valid for iphone passes

Example:

"#EFEFEF"

data.attributes.passDesign.textColor

string

Pass text color in hex format. Only valid for iphone passes

Example:

"#EFEFEF"

data.attributes.passDesign.bannerImageUrl

string

URL of pass banner image

data.attributes.passDesign.logoImageUrl

string

URL of pass logo image

data.attributes.locations

object[]

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

Show child attributes

data.attributes.locations.name

string

Name of the location, used for display purposes only

Example:

"West Entrance"

data.attributes.locations.latitude

number<double>

Latitude of the location

Example:

51.54321132456805

data.attributes.locations.longitude

number<double>

Longitude of the location

Example:

-0.022901231803803924

data.attributes.locations.radius

integer

default:100

Effective geofence radius of the location in meters. Maximum is 1000 for eventTicket passes, 100 for other pass types. Currently only available on Apple devices, due to Android device restrictions.

Required range: 10 <= x <= 1000

Example:

90

data.attributes.locations.message

string

Message to display when user enters geofence. Currently only available on Apple devices, due to Android device restrictions.

Example:

"Welcome! Enjoy the show!"

data.attributes.locations.address

string

Geocoded address of the location. Used for display purposes only. This is calculated automatically from the latitude and longitude values

Example:

"Mick's Garage, Queens Yard, London, England, E9 5EN, United Kingdom"

data.attributes.beacons

object[]

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

Show child attributes

data.attributes.beacons.proximityUuid

string

Unique identifier of the beacon

Example:

"E2C56DB5-DFFB-48D2-B060-D0F5A71096E0"

data.attributes.beacons.major

integer

Major Value, provides additional identification for a beacon

Example:

65535

data.attributes.beacons.minor

integer

Minor Value, provides additional identification for a beacon

Example:

8525

data.attributes.beacons.message

string | null

Message to display on lock screen when the user is in range of the beacon

Example:

"You're near my store"

data.attributes.beacons.name

string

Name of the beacon, used for display purposes only

Example:

"West Entrance"

data.attributes.passSource

object

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

Show child attributes

data.attributes.passSource.oneOf

object

Show child attributes

data.attributes.passSource.oneOf.appleBase64

string

Apple Wallet Pass Base64 string, to generate the pass, decode the string and save as a .pkpass file. Will prompt the user to download the pass to their Apple Wallet when opened on an iPhone.

data.attributes.passSource.oneOf.googleDownloadUrl

string

Google Wallet Pass download URL. Will prompt the user to download the pass to their Google Wallet when opened on an Android device.

Introduction

Entities

Pass Templates

Passes

Readers

Scans

Loyalty

Webhook Subscriptions

Webhooks

Batches

Authorizations

Path Parameters

Query Parameters

Response