List passes
Lists passes, newest first by default, with cursor pagination. Filter by status, project, template, stored variables (variable=key:value, repeatable), scanner validity (validOn), or redemption state (redeemed, optionally scoped to one scan context with redeemedContext).
Requires the passes:read scope on the access token.
Authorizations
Passlet access token (plt_*) sent as Authorization: Bearer <token> or X-API-Key. Authorized scopes are listed per operation under x-required-scopes.
Query Parameters
Number of items per page
1 <= x <= 100Opaque cursor returned by the previous page
1 - 512Deprecated offset compatibility parameter
0 <= x <= 9007199254740991Filter by one or more statuses
1QUEUED, ISSUING, ISSUED, VOID, FAILED, EXPIRED Filter by external ID
Search by label, status, or external pass ID
1 - 255Filter by project. UUID = that project; the string "null" = uncategorised passes.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Filter by template — matches passes issued from any version of this template.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Repeatable key:value filter on stored pass variables (exact, trimmed match; value = everything after the first ":"). Same key repeated = any-of; different keys must all match. Max 5 entries. Example: variable=memberTier:gold&variable=region:EU
1 - 5 elementsStored-variable filter entry in key:value form.
3 - 2177Only passes valid for scanning on this date (YYYY-MM-DD). Matches passes with a redemption window containing the date; passes that declare no windows are always valid.
^\d{4}-\d{2}-\d{2}$Filter passes by whether they are redeemed — i.e. have an unreversed accepted scan (scoped by redeemedContext).
Scope the redeemed filter to one scan context key (e.g. an event day). Only meaningful together with redeemed.
128Sort field
createdAt, updatedAt, label, status, externalPassId Sort direction
asc, desc Response
OK
Total number of items
-9007199254740991 <= x <= 9007199254740991Items per page
-9007199254740991 <= x <= 9007199254740991Items skipped
-9007199254740991 <= x <= 9007199254740991Whether more items exist
Opaque cursor for the next page, or null when exhausted