Get information about a pass-template

URL
https://app.passcreator.com/api/pass-template/{pass-uid}
HTTP-Method
GET
Purpose
Get information about the given pass-template. This information is e.g. needed if you want to create passes for this pass-template.
Required input parameters

• HTTP Authorization Header that contains your API key

• UID of the pass-template that must be specified in the URI. If you don't have a UID you can obtain it by using the function explained in the section "Get list of pass templates."

Returned values

JSON-Array containing the following values:

• identifier: the UID of the pass-template

• name: the name of the pass-template

• numberOfCreatedPasses: 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.

• createPassUrl: the API url including the pass-template UID that must be used to create new passes.

• dynamicFields: 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 document.

Example output:

  1. {
  2. "identifier": "6d03a4a9-cf92-4e36-80b4-a8994546e2f7",
  3. "name": "Example Passbook pass",
  4. "numberOfCreatedPasses": 1220,
  5. "createPassUrl": "https://app.passcreator.com/api/pass?passtemplate=6d03a4a9-cf92-4e36-80b4-a8994546e2f7",
  6. "dynamicFields": {
  7. "passFrontFields": {
  8. "headerFields": [
  9. {
  10. "value": "Valid to"
  11. }
  12. ],
  13. "primaryFields": [
  14. {
  15. "value": "Customer-No."
  16. }
  17. ]
  18. },
  19. "passBackFields": [],
  20. "additionalProperties": {
  21. "Vorname": "5b3f2f9f66a228.52093670",
  22. "Nachname": "5b3f2f9f66a3e9.44793220"
  23. }
  24. }
  25. }