This documentation is currently under development. Certain sections are not yet complete and will be added shortly.
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Pass Export

Export passes as an Excel file using a time-limited download token.

get
/api/{tenantId}/passes/export/download

Validates the signed token (obtained from POST export/token), extracts the filters, and streams the xlsx file. No Authorization header is required — the token is the credential.

Path parameters
tenantIdstringRequired
Query parameters
tokenstringOptional

Signed download token from POST export/token.

Responses
200

Excel file returned successfully.

No content

get/api/{tenantId}/passes/export/download

No content

Create a time-limited download token for exporting passes as Excel.

post
/api/{tenantId}/passes/export/token

Returns a short-lived signed URL (valid 5 minutes) that can be used to download the xlsx without an Authorization header. Filters are embedded in the token.

Required scopes
This endpoint requires the following scopes:
Authorizations
OAuth2implicitRequired
Authorization URL:
Path parameters
tenantIdstringRequired
Bodyobject · FilterModel[]

Filter specification for pass queries.

fieldstringOptional

Field to filter by (identifiers., metadata., passType, installationStatus).

operatorstring · enumOptional

Comparison operator to apply.

Possible values:
valuestring[] · nullableOptional

Filter values. Single-element for most operators; multiple elements for in and notIn. The query parameter name is value (repeated for multiple values). Single value (equals, contains, startsWith, …):

GET /passes?filter[0].field=passType&filter[0].operator=equals&filter[0].value=boarding

Multiple values (in / notIn):

GET /passes?filter[0].field=passType&filter[0].operator=in&filter[0].value=boarding&filter[0].value=loyalty

Multiple filters combined:

GET /passes?filter[0].field=passType&filter[0].operator=equals&filter[0].value=boarding
           &filter[1].field=identifiers.customerId&filter[1].operator=startsWith&filter[1].value=CUST-
```</example>
Responses
200

Download token created successfully.

downloadUrlstringOptional
post/api/{tenantId}/passes/export/token
200

Download token created successfully.

Last updated