Show Pass Template (Deprecated)

GET

api

pass_templates

{pass_template_uuid}

curl --request GET \
  --url https://api.passentry.com/api/v1/pass_templates/{pass_template_uuid} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "f0af94dc3c69a80cee32c173",
    "type": "passTemplate",
    "attributes": {
      "backgroundColor": "#EFEFEF",
      "name": "Summer Sale 2023",
      "description": "Summer Sale Pass",
      "labelColor": "#FF8477",
      "textColor": "#29323A",
      "templateType": "storeCard",
      "header": {
        "header_one": {
          "id": "name",
          "label": "Name",
          "default_value": null
        },
        "header_two": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "header_three": {
          "id": null,
          "label": null,
          "default_value": null
        }
      },
      "primary": {
        "primary_one": {
          "id": "attendee",
          "label": "Attendee",
          "default_value": null
        },
        "primary_two": {
          "id": null,
          "label": null,
          "default_value": null
        }
      },
      "secondary": {
        "secOne": {
          "id": "address",
          "label": "Address",
          "default_value": null
        },
        "secTwo": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "secThree": {
          "id": null,
          "label": null,
          "default_value": null
        }
      },
      "auxiliary": {
        "auxOne": {
          "id": "dob",
          "label": "DOB",
          "default_value": null
        },
        "auxTwo": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "auxThree": {
          "id": null,
          "label": null,
          "default_value": null
        }
      },
      "backFields": {
        "backOne": {
          "id": "website",
          "label": "Website",
          "default_value": null
        },
        "backTwo": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "backFive": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "backFour": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "backThree": {
          "id": null,
          "label": null,
          "default_value": null
        }
      }
    }
  }
}

Authorizations

Authorization

string

header

required

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

Path Parameters

pass_template_uuid

string

required

pass_template_uuid

Response

200

application/json

successful

data

object

data.id

string

Auto-generated UUID of the pass template

Example:

"1fed3fbb1a8bec4ed1bddf38"

data.type

string

Example:

"passTemplate"

data.attributes

object

data.attributes.backgroundColor

string

Must be a valid hex color code

Example:

"#EFEFEF"

data.attributes.name

string

Name of the pass template, set on creation. Not displayed on the pass

Example:

"Summer Sale 2023"

data.attributes.description

string

Pass description, displayed on the pass

Example:

"Summer Sale Pass"

data.attributes.labelColor

string

Must be a valid hex color code. Only valid for iphone passes

Example:

"#FF8477"

data.attributes.textColor

string

Must be a valid hex color code. Only valid for iphone passes

Example:

"#29323A"

data.attributes.templateType

enum<string>

Passes created from this template will be of this type

Available options:

generic,

eventTicket,

storeCard

data.attributes.header

string | null

Pass Header Label

data.attributes.secondary

object

Pass Secondary Labels

data.attributes.secondaryValues

object

Pass Secondary default values

data.attributes.auxiliary

object

Pass Auxiliary Labels

data.attributes.auxiliaryValues

object

Pass Auxiliary default values

data.attributes.backFields

object

Pass Back Field Labels

data.attributes.backFieldValues

object

Pass Back Field default values

Was this page helpful?

Pass Templates Create pass

curl --request GET \
  --url https://api.passentry.com/api/v1/pass_templates/{pass_template_uuid} \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "id": "f0af94dc3c69a80cee32c173",
    "type": "passTemplate",
    "attributes": {
      "backgroundColor": "#EFEFEF",
      "name": "Summer Sale 2023",
      "description": "Summer Sale Pass",
      "labelColor": "#FF8477",
      "textColor": "#29323A",
      "templateType": "storeCard",
      "header": {
        "header_one": {
          "id": "name",
          "label": "Name",
          "default_value": null
        },
        "header_two": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "header_three": {
          "id": null,
          "label": null,
          "default_value": null
        }
      },
      "primary": {
        "primary_one": {
          "id": "attendee",
          "label": "Attendee",
          "default_value": null
        },
        "primary_two": {
          "id": null,
          "label": null,
          "default_value": null
        }
      },
      "secondary": {
        "secOne": {
          "id": "address",
          "label": "Address",
          "default_value": null
        },
        "secTwo": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "secThree": {
          "id": null,
          "label": null,
          "default_value": null
        }
      },
      "auxiliary": {
        "auxOne": {
          "id": "dob",
          "label": "DOB",
          "default_value": null
        },
        "auxTwo": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "auxThree": {
          "id": null,
          "label": null,
          "default_value": null
        }
      },
      "backFields": {
        "backOne": {
          "id": "website",
          "label": "Website",
          "default_value": null
        },
        "backTwo": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "backFive": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "backFour": {
          "id": null,
          "label": null,
          "default_value": null
        },
        "backThree": {
          "id": null,
          "label": null,
          "default_value": null
        }
      }
    }
  }
}

Introduction

Entities

Pass Templates

Passes

Readers

Scans

Loyalty

Webhooks

Batches

Show Pass Template (Deprecated)

Authorizations

Path Parameters

Response