Get Information About a Pass-Template

Get information about the given pass-template. This information is e.g. needed if you want to create passes for this pass-template.

This endpoint is deprecated and should no longer be used. Please use the endpoint that describes a template which includes a lot more data.

GET/api/pass-template/{identifier}

Get Information About a Pass-Template

Get information about the given pass-template.

Path Parameters

Name
identifier
Type
string
(mandatory)
Description
This is the UUID of the template you want to get information about.

Query Parameters

Name
includeLocations
Type
boolean
(optional)
Description
Set this GET parameter to true if you want to receive an array that contains the current locations.

Example URLs

Request URL without parameter

https://app.passcreator.com/api/pass-template/6d03a4a9-cf92-4e36-80b4-a8994546e2f7

Request URL with parameter

https://app.passcreator.com/api/pass-template/6d03a4a9-cf92-4e36-80b4-a8994546e2f7?includeLocations=true

Authorization

Name
Authorization
Type
string
(mandatory)
Description
HTTP Header containing your API key. Replace yourApiKeyHere with your actual API key.

Example HTTP Header

HTTP header

GET /api/pass-template/{identifier} HTTP/1.1
Host: app.passcreator.com
Authorization: yourApiKeyHere

Returned Values

JSON-Array containing the following values:

Name
identifier
Type
string
(mandatory)
Description
The UID of the pass-template.
Name
name
Type
string
(mandatory)
Description
The name of the pass-template.
Name
numberOfCreatedPasses
Type
integer
(mandatory)
Description
The number of created passes for this pass-template. Pay attention that this is the overall number of passes that have been created, not the number of passes created this month.
Name
createPassUrl
Type
string
(mandatory)
Description
The API url including the pass-template UID that must be used to create new passes.
Name
dynamicFields
Type
object
(mandatory)
Description
JSON-Array that specifies the array that must be submitted when passes are created or updated. For more details see "Create a new pass" in this documentation.
Name
locations
Type
array<object>
(optional)
Description
Array that contains the current locations (multi-dimensional array with parameters latitude, longitude and optionally altitude, maxDistance and relevantText). Only returned if includeLocations is set to true.

Example Response

Response

{
  "identifier": "6d03a4a9-cf92-4e36-80b4-a8994546e2f7",
  "name": "Example Passbook pass",
  "numberOfCreatedPasses": 1220,
  "createPassUrl": "https://app.passcreator.com/api/pass?passtemplate=6d03a4a9-cf92-4e36-80b4-a8994546e2f7",
  "dynamicFields": {
    "passFrontFields": {
      "headerFields": [
        {
          "value": "Valid to"
        }
      ],
      "primaryFields": [
        {
          "value": "Customer-No."
        }
      ]
    },
    "passBackFields": [],
    "additionalProperties": {
      "Vorname": "5b3f2f9f66a228.52093670",
      "Nachname": "5b3f2f9f66a3e9.44793220"
    }
  }
}

Code Examples

Here you can find examples of how to call this endpoint using different programming languages and tools.

Replace 6d03a4a9-cf92-4e36-80b4-a8994546e2f7 with your actual pass-template identifier and yourApiKeyHere with your actual API key.

Request Examples

GET

/api/pass-template/{identifier}

curl -X GET "https://app.passcreator.com/api/pass-template/6d03a4a9-cf92-4e36-80b4-a8994546e2f7" \
  -H "Authorization: yourApiKeyHere"