Skip to main content
GET
cURL

Authorizations

Authorization
string
header
required

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

Path Parameters

templateId
string
required

Query Parameters

accountId
string

Response

Default Response

A template is the basis of a pass it defines the appearance of a pass and properties that don't change between instances of passes.

foregroundColor
string
required

(Apple and Web Only) A hex or rgb value providing the foreground color. This is used for font color

Pattern: ^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$
backgroundColor
string
required

A hex or rgb value providing the foreground color

Pattern: ^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$
icon
string
required

A url to an image of size X by Y.

The icon but with text and doesnt need to be square

banner
string
required

(Google, Apple Only) A url to an image of size X by Y. Also used in link previews.

title
string
required

The title displayed on the pass.

Minimum string length: 1
issuerName
string
required

The name of the issuer.

Minimum string length: 1
id
string
required

Id is a unique identifier for the template

accountId
string
required

Account Id is the account the template belongs to

labelColor
string

(Apple Only) A hex or rgb value providing the label color. If unset then the foreground color is used.

Pattern: ^(#([a-fA-F0-9]{3}){1,2}|(rgb|rgba)(s*(d+%?s*,s*){2,3}(d+%?s*,?s*)d*.?d*s*))$
background
string

(Web Only) A url to an image that is displayed as the background. If this is not provided then backgroundColor is used.

sharingProhibited
boolean

Disable sharing from mobile wallets

type
enum<string>
Available options:
offer
fields
object[]
Maximum array length: 4
backFields
object[]

The values can be text, numbers or urls.