Pass Export
Export passes as an Excel file using a time-limited download token.
get
/api/{tenantId}/passes/export/download
Path parameters
tenantIdstringRequired
Query parameters
tokenstringOptional
Signed download token from POST export/token.
Responses
200
Excel file returned successfully.
No content
400
Token is missing, invalid, or expired.
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
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 · enumOptionalPossible values:
Comparison operator to apply.
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

