Get All Passes of a Pass-Template

This endpoint returns a list of all passes for the given pass-template.

This endpoint is deprecated and the maximum number of passes that will be returned is 1000. To make your queries more efficient, use the new list endpoint that supports pagination.

GET/api/pass/?passId={pass-template-uid}

Get All Passes of a Pass-Template

Returns a list of all passes for the given pass-template.

Query Parameters

Name
passId
Type
string
(mandatory)
Description
Pass-template UID as parameter.

Example URL

Request URL

https://app.passcreator.com/api/pass/?passId={pass-template-uid}

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/?passId={pass-template-uid} HTTP/1.1
Host: app.passcreator.com
Authorization: yourApiKeyHere

Returned Values

JSON-Array containing an array for every pass. The array for the passes contain these fields:

Name
identifier
Type
string
(mandatory)
Description
The UID of the pass that can be used e.g. for updates.
Name
uri
Type
string
(mandatory)
Description
The URI of the pass that can be used to update or delete it.
Name
generatedId
Type
string
(mandatory)
Description
The unique ID that is created for every pass and can e.g. be used for admittance tools to check if a given ID is valid. This ID is usually encoded in the Barcode on the pass if you're not using own IDs.
Name
voided
Type
boolean
(mandatory)
Description
false, if the pass is not voided, means it has not been used. true, if the pass is voided, means it has been used already.
Name
searchString
Type
string
(mandatory)
Description
Contains all data on the pass separated by pipe symbols |.

Example Response

Response

[
  {
    "identifier": "64d55135-8a4c-afb0-e107-4d17d771b9c5",
    "uri": "https://app.passcreator.com/api/pass/64d55135-8a4c-afb0-e107-4d17d771b9c5",
    "generatedId": "552168de589ac1.65142085",
    "voided": false,
    "searchString": "552168de589ac1.65142085|no value specified||test|test|"
  },
  {
    "identifier": "a4d65132-8a1c-afv2-e107-4d17d771b9c5",
    "uri": "https://app.passcreator.com/api/pass/a4d65132-8a1c-afv2-e107-4d17d771b9c5",
    "generatedId": "152168de589ac1.65142085",
    "voided": false,
    "searchString": "152168de589ac1.65142085|no value specified||test|test|"
  }
]

Code Examples

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

Replace 64d55135-8a4c-afb0-e107-4d17d771b9c5 with your actual pass-template identifier and yourApiKeyHere with your actual API key.

Request Examples

GET

/api/pass/?passId={pass-template-uid}

curl -X GET "https://app.passcreator.com/api/pass/?passId=64d55135-8a4c-afb0-e107-4d17d771b9c5" \
  -H "Authorization: yourApiKeyHere"