Skip to main content
GET
List passes

Authorizations

Authorization
string
header
required

API key authentication. Include your API key as a Bearer token.

Example: Bearer sk_prod_xxxxxx

Get your API key from the Stell Dashboard.

Query Parameters

phoneNumber
string

Filter passes by holder mobile number: customer.mobileNumber, or the deprecated top-level phoneNumber on older passes. Exact match, so send the number in the format it was stored (E.164 for customer.mobileNumber).

email
string

Filter passes by holder email address: customer.emailAddress, or the deprecated top-level email on older passes. Exact match.

limit
string

Maximum number of passes to return per page (1-100). Defaults to 100.

nextToken
string

Pagination token from previous response.

externalId
string

Filter passes by external reference ID.

programId
string

Filter passes by specific program ID.

status
string

Filter passes by current status.

walletType
string

Filter passes by wallet platform.

Response

Successful response with pass list

data
object
required

Page of passes plus the pagination cursor

requestId
string
required

Unique request identifier for debugging

Pattern: ^[0-9A-Z]{26}$