Skip to main content
GET
List passes

Authorizations

Authorization
string
header
required

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

limit
integer
default:20

Number of items per page

Required range: 1 <= x <= 100
cursor
string

Opaque cursor returned by the previous page

Required string length: 1 - 512
offset
integer
default:0

Deprecated offset compatibility parameter

Required range: 0 <= x <= 9007199254740991
status
enum<string>[]

Filter by one or more statuses

Minimum array length: 1
Available options:
QUEUED,
ISSUING,
ISSUED,
VOID,
FAILED,
EXPIRED
externalPassId
string

Filter by external ID

Search by label, status, or external pass ID

Required string length: 1 - 255
label
string

Filter by label. Matching is case-insensitive; see labelMatch.

Required string length: 1 - 255
labelMatch
enum<string>

How label matches: "contains" (default) = substring, "exact" = whole-label equality. Both case-insensitive.

Available options:
contains,
exact
Example:

"contains"

templateVersion
string

Filter by pinned template version number. Bare number = exactly (templateVersion=3); prefix with gte:/lte: for at least / at most (templateVersion=gte:3).

Pattern: ^(?:(?:gte|lte):)?[1-9][0-9]{0,8}$
revision
string

Filter by head revision number. Bare number = exactly (revision=3); prefix with gte:/lte: for at least / at most (revision=lte:7).

Pattern: ^(?:(?:gte|lte):)?[1-9][0-9]{0,8}$
upgradeAvailable
boolean

true = pinned below its template’s latest published version; false = pinned at it (up to date). Passes with no pinned template version match neither.

createdFrom
string<date-time>

Only passes created at or after this instant (inclusive). ISO 8601.

Pattern: ^(?:(?:\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)))$
createdTo
string<date-time>

Only passes created before this instant (exclusive). ISO 8601.

Pattern: ^(?:(?:\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)))$
projectId

Filter by project. UUID = that project; the string "null" = uncategorised passes.

Pattern: ^([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)$
templateId
string<uuid>

Filter by template: matches passes issued from any version of this template.

Pattern: ^([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)$
variable
string[]

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

Required array length: 1 - 5 elements

Stored-variable filter entry in key:value form.

Required string length: 3 - 2177
validOn
string

Only 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.

Pattern: ^\d{4}-\d{2}-\d{2}$
redeemed
boolean

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.

sortBy
enum<string>
default:createdAt

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).

Available options:
createdAt,
updatedAt,
label,
status,
externalPassId,
templateName,
templateVersion,
revision
Example:

"createdAt"

sortDir
enum<string>
default:desc

Sort direction

Available options:
asc,
desc
Example:

"asc"

Response

OK

items
object[]
required
total
integer
required

Total number of items

Required range: -9007199254740991 <= x <= 9007199254740991
limit
integer
required

Items per page

Required range: -9007199254740991 <= x <= 9007199254740991
offset
integer
required

Items skipped

Required range: -9007199254740991 <= x <= 9007199254740991
hasMore
boolean
required

Whether more items exist

nextCursor
string | null

Opaque cursor for the next page, or null when exhausted