Skip to main content
GET
Search and filter Wallet Passes

Authorizations

Authorization
string
header
required

Bearer token authentication

Headers

x-workspace-id
string

Workspace ID to perform the operation in. If not provided, system will use the first one assigned to the user

Pattern: ^[a-zA-Z0-9-_]+$

Query Parameters

query
string

Search keyword to filter passes by name (case-insensitive)

Maximum string length: 255
cursor
string

Pagination cursor for fetching the next set of results. Use the 'cursor' value from the previous response.

limit
integer

Number of passes to return per page (1-20, max 20)

Required range: 1 <= x <= 20
includePassAssets
boolean

Include pass asset URLs (images) in the response

summary
boolean

Return only basic pass information (summary mode)

id
string

Filter by specific pass ID

Pattern: ^[a-zA-Z0-9-_]+$
ids
string[]

Filter by a list of pass IDs

passName
string

Exact search by pass name (case-sensitive)

Maximum string length: 255
status
enum<string>[]

Filter passes by status. Multiple values allowed.

Available options:
Draft,
Published

Response

Successfully retrieved wallet passes

items
any[]
cursor
string
hasMore
boolean