List passes
Lists passes, newest first by default, with cursor pagination. Filter by status, label (label + labelMatch), project, template, pinned template version and head revision (templateVersion / revision, as a bare number or gte:/lte: prefixed), version freshness (upgradeAvailable), creation interval (createdFrom/createdTo, half-open), stored variables (variable=key:value, repeatable), scanner validity (validOn), or redemption state (redeemed). Sorting by the computed fields templateName, templateVersion or revision paginates by offset continuation cursors; prefer the row-field sorts for long-running exports.
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 label. Matching is case-insensitive; see labelMatch.
1 - 255How label matches: "contains" (default) = substring, "exact" = whole-label equality. Both case-insensitive.
contains, exact "contains"
Filter by pinned template version number. Bare number = exactly (templateVersion=3); prefix with gte:/lte: for at least / at most (templateVersion=gte:3).
^(?:(?:gte|lte):)?[1-9][0-9]{0,8}$Filter by head revision number. Bare number = exactly (revision=3); prefix with gte:/lte: for at least / at most (revision=lte:7).
^(?:(?:gte|lte):)?[1-9][0-9]{0,8}$true = pinned below its template’s latest published version; false = pinned at it (up to date). Passes with no pinned template version match neither.
Only passes created at or after this instant (inclusive). ISO 8601.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Only passes created before this instant (exclusive). ISO 8601.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$Filter 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 whose authored start date equals the selected date; passes that declare no windows are always valid.
^\d{4}-\d{2}-\d{2}$Filter passes by redemption state. With validOn, a windowed pass is redeemed only when it has an accepted scan in the window starting on that date; without validOn (or without windows), redemption is lifetime-wide.
Sort field. templateName/templateVersion/revision are computed fields: passes without a pinned template version sort last, and their cursors are offset continuations (prefer row-field sorts for long-running exports).
createdAt, updatedAt, label, status, externalPassId, templateName, templateVersion, revision "createdAt"
Sort direction
asc, desc "asc"
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