Show Pass Template

This endpoint is currently in open beta and available to all users – let us know if you encounter any issues or have feedback.

Authorizations

Authorization

string

header

required

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

Path Parameters

string

required

Pass Template UUID

Query Parameters

fields

string

Returns a partial response (Sparse fieldset), instead of the whole record. Set one or many comma separated record attributes

Example:

"name,description,templateType"

Response

Successful

data

Pass template · object

Pass template
Processing pass template

Show child attributes

data.id

string

Unique identifier for the pass template

Example:

"19cb334f9696e64e10e7759f0"

data.type

string

Example:

"passTemplate"

data.attributes

object

Show child attributes

data.attributes.name

string

Name of the pass template, used for display purposes

Example:

"PassEntry Supermarket"

data.attributes.templateType

enum<string>

Type of pass template, determines the design and functionality of the pass

Available options:

generic,

loyalty,

eventTicket,

transit

data.attributes.transitType

enum<string>

Transit type for the transit pass template

Available options:

airplane,

bus,

train,

ferry,

other

data.attributes.defaultLanguage

string

Language code (ISO 639-1) used as the default language for labels on this template

Example:

"en"

data.attributes.centralTitle

string

Used for Google Wallet Passes, pass Title

Example:

"PassEntry Supermarket"

data.attributes.notificationHeader

string

Header text to be displayed on notifications

Example:

"PassEntry Supermarket"

data.attributes.colors

object

Show child attributes

data.attributes.colors.background

string

Background color of the pass template

Example:

"#EFEFEF"

data.attributes.colors.label

string

Label color of the pass template

Example:

"#FF8477"

data.attributes.colors.text

string

Text color of the pass template

Example:

"#29323A"

data.attributes.images

object

Images for the pass template, will be direct link URLs

Show child attributes

data.attributes.images.banner

string

Banner image URL, used unless platform specific images are provided

Example:

"https://example.com/banner.png"

data.attributes.images.logo

string

Logo image URL, used unless platform specific images are provided

Example:

"https://example.com/logo.png"

data.attributes.images.icon

string

Icon image URL, used unless platform specific images are provided

Example:

"https://example.com/icon.png"

data.attributes.images.watermark

object

PassEntry logo watermark. To remove watermark, contact Sales at PassEntry. Otherwise, watermak is required

Show child attributes

data.attributes.images.watermark.color

enum<string>

Color of the watermark, light or dark

Available options:

light,

dark

data.attributes.images.watermark.position

enum<string>

Position of the watermark, top left, top right, bottom left, or bottom right

Available options:

topLeft,

topRight,

bottomLeft,

bottomRight

data.attributes.images.apple

object

Show child attributes

data.attributes.images.apple.banner

string

Banner image URL, used for Apple Wallet

Example:

"https://example.com/apple_banner.png"

data.attributes.images.apple.logo

string

Logo image URL, used for Apple Wallet

Example:

"https://example.com/apple_logo.png"

data.attributes.images.apple.icon

string

Icon image URL, used for Apple Wallet

Example:

"https://example.com/apple_icon.png"

data.attributes.images.apple.thumbnail

string

Thumbnail image URL, used for Apple Wallet

Example:

"https://example.com/apple_thumbnail.png"

data.attributes.images.apple.watermark

object

PassEntry logo watermark. To remove watermark, contact Sales at PassEntry. Otherwise, watermak is required

Show child attributes

data.attributes.images.apple.watermark.color

enum<string>

Color of the watermark, light or dark

Available options:

light,

dark

data.attributes.images.apple.watermark.position

enum<string>

Position of the watermark, top left, top right, bottom left, or bottom right

Available options:

topLeft,

topRight,

bottomLeft,

bottomRight

data.attributes.images.google

object

Show child attributes

data.attributes.images.google.banner

string

Banner image URL, used for Google Wallet

Example:

"https://example.com/google_banner.png"

data.attributes.images.google.logo

string

Logo image URL, used for Google Wallet

Example:

"https://example.com/google_logo.png"

data.attributes.images.google.wideLogo

string

Wide logo image URL, used for Google Wallet

Example:

"https://example.com/google_wide_logo.png"

data.attributes.images.google.watermark

object

PassEntry logo watermark. To remove watermark, contact Sales at PassEntry. Otherwise, watermak is required

Show child attributes

data.attributes.images.google.watermark.color

enum<string>

Color of the watermark, light or dark

Available options:

light,

dark

data.attributes.images.google.watermark.position

enum<string>

Position of the watermark, top left, top right, bottom left, or bottom right

Available options:

topLeft,

topRight,

bottomLeft,

bottomRight

data.attributes.fields

object

Fields for the pass template, for exact positioning of fields please review our design guidelines

Show child attributes

data.attributes.fields.header

object

Show child attributes

data.attributes.fields.header.one

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.header.one.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.header.one.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.header.one.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.header.one.localisation

object

Optional. Localised overrides for field labels and values, keyed by BCP-47/ISO language code (e.g., en, fr, is). Omitted entirely if no translations are provided. This feature is available on request and works only via the Pass Templates API (not dashboard), please contact PassEntry to enable localisation for your organisation.

Show child attributes

data.attributes.fields.header.one.localisation.{key}

object

Show child attributes

data.attributes.fields.header.one.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.header.one.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.header.two

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.header.two.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.header.two.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.header.two.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.header.two.localisation

object

Show child attributes

data.attributes.fields.header.two.localisation.{key}

object

Show child attributes

data.attributes.fields.header.two.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.header.two.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.central

object

Central field for the pass template.

Note: Please use both one and two fields for transit type

Show child attributes

data.attributes.fields.central.one

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.central.one.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.central.one.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.central.one.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.central.one.localisation

object

Show child attributes

data.attributes.fields.central.one.localisation.{key}

object

Show child attributes

data.attributes.fields.central.one.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.central.one.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.central.two

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.central.two.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.central.two.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.central.two.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.central.two.localisation

object

Show child attributes

data.attributes.fields.central.two.localisation.{key}

object

Show child attributes

data.attributes.fields.central.two.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.central.two.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details

object

Show child attributes

data.attributes.fields.details.one

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.details.one.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.details.one.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.details.one.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.details.one.localisation

object

Show child attributes

data.attributes.fields.details.one.localisation.{key}

object

Show child attributes

data.attributes.fields.details.one.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.one.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.two

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.details.two.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.details.two.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.details.two.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.details.two.localisation

object

Show child attributes

data.attributes.fields.details.two.localisation.{key}

object

Show child attributes

data.attributes.fields.details.two.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.two.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.three

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.details.three.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.details.three.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.details.three.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.details.three.localisation

object

Show child attributes

data.attributes.fields.details.three.localisation.{key}

object

Show child attributes

data.attributes.fields.details.three.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.three.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.four

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.details.four.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.details.four.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.details.four.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.details.four.localisation

object

Show child attributes

data.attributes.fields.details.four.localisation.{key}

object

Show child attributes

data.attributes.fields.details.four.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.four.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.five

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.details.five.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.details.five.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.details.five.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.details.five.localisation

object

Show child attributes

data.attributes.fields.details.five.localisation.{key}

object

Show child attributes

data.attributes.fields.details.five.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.five.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.six

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.details.six.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.details.six.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.details.six.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.details.six.localisation

object

Show child attributes

data.attributes.fields.details.six.localisation.{key}

object

Show child attributes

data.attributes.fields.details.six.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.details.six.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back

object

Show child attributes

data.attributes.fields.back.one

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.back.one.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.back.one.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.back.one.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.back.one.localisation

object

Show child attributes

data.attributes.fields.back.one.localisation.{key}

object

Show child attributes

data.attributes.fields.back.one.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.one.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.two

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.back.two.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.back.two.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.back.two.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.back.two.localisation

object

Show child attributes

data.attributes.fields.back.two.localisation.{key}

object

Show child attributes

data.attributes.fields.back.two.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.two.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.three

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.back.three.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.back.three.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.back.three.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.back.three.localisation

object

Show child attributes

data.attributes.fields.back.three.localisation.{key}

object

Show child attributes

data.attributes.fields.back.three.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.three.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.four

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.back.four.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.back.four.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.back.four.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.back.four.localisation

object

Show child attributes

data.attributes.fields.back.four.localisation.{key}

object

Show child attributes

data.attributes.fields.back.four.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.four.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.five

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.back.five.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.back.five.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.back.five.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.back.five.localisation

object

Show child attributes

data.attributes.fields.back.five.localisation.{key}

object

Show child attributes

data.attributes.fields.back.five.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.five.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.six

object

Field object. Set value to null to remove the field.

Show child attributes

data.attributes.fields.back.six.id

string

Field ID, used to to target and identify a specific field. Must be unique within the pass template or pass. Required if field is used.

Example:

"membership_tier"

data.attributes.fields.back.six.label

string

Label of the field. This will be displayed to the user in the pass.

Example:

"Membership Tier"

data.attributes.fields.back.six.defaultValue

string

Default value of the field. This will be displayed to the user in the pass if no value is provided.

Example:

"Gold"

data.attributes.fields.back.six.localisation

object

Show child attributes

data.attributes.fields.back.six.localisation.{key}

object

Show child attributes

data.attributes.fields.back.six.localisation.{key}.label

string

Localised label to be displayed for this field when the user language matches the provided language code

data.attributes.fields.back.six.localisation.{key}.defaultValue

string

Localised default value to be displayed for this field when the user language matches the provided language code

data.attributes.appLinking

object

Used to add a link on your pass to an app or website.

Show child attributes

data.attributes.appLinking.apple

object

Show child attributes

data.attributes.appLinking.apple.appStoreUrl

string[]

Apple App Store app URL

data.attributes.appLinking.google

Web link · object

Link to your android App or website

Web link
Android app link

Show child attributes

data.attributes.appLinking.google.web

object

Show child attributes

data.attributes.appLinking.google.web.url

string

HTTPs URL web link, will open in browser when tapped

Example:

"https://passentry.com/"

data.attributes.appLinking.google.displayText

object

Show child attributes

data.attributes.appLinking.google.displayText.text

string

Set custom text to be displayed as link text, default is 'Open Pass'

data.attributes.locations

object[]

Array of locations. Maximum of 10 locations

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[]

Array of beacons, currently only available on Apple devices, due to Android device restrictions. Maximum of 10 beacons

Show child attributes

data.attributes.beacons.name

string

required

Name of the beacon, used for display purposes only

Example:

"West Entrance"

data.attributes.beacons.proximityUuid

string

required

Unique identifier of the beacon

Example:

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

data.attributes.beacons.major

integer

Major Value, provides additional identification for a beacon

Required range: 0 <= x <= 65535

Example:

1246

data.attributes.beacons.minor

integer

Minor Value, provides additional identification for a beacon

Required range: 0 <= x <= 65535

Example:

6421

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.barcode

object

Barcode for a pass template

Show child attributes

data.attributes.barcode.enabled

boolean

If true, barcode will be added to the pass

data.attributes.barcode.type

enum<string>

Barcode type

Available options:

qr,

code128,

aztec,

pdf417

data.attributes.barcode.source

enum<string>

Source of the barcode

Available options:

custom,

uuid,

extId

data.attributes.barcode.value

string

Barcode value. You can leave it blank if the value will be dynamically set in the pass, but you can also provide a default.

You can make the value dynamic using the %{passData.xyz} syntax (e.g., Hello, %{passData.extId}). Currently, only %{passData.extId} and %{passData.uuid} are supported.

If source is set to extId or uuid, the value will be automatically populated and can be left blank.

Example:

"abc123"

data.attributes.barcode.displayText

boolean

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

data.attributes.loyaltyBalance

object

Loyalty balance for the pass template.

Show child attributes

data.attributes.loyaltyBalance.enabled

boolean

If enabled, pass will have a loyalty balance field that can be updated via the loyalty API.

data.attributes.loyaltyBalance.numberType

enum<string>

Type of number to be displayed on the pass, number will be converted to this type.

Available options:

integer,

decimal

data.attributes.googleNfcEnabled

boolean

Only included on loyalty templates, if true, pass will be enabled for Google Wallet NFC.

Introduction

Entities

Pass Templates

Passes

Readers

Scans

Loyalty

Webhook Subscriptions

Webhooks

Batches

Show Pass Template

Authorizations

Path Parameters

Query Parameters

Response