List passes
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Query Parameters
Record limiter per page. Default is 100
Filter passes by status. Accepts single status or multiple statuses.
issued
, active
, removed
, deactivated
Filter passes by device type
android
, iphone
Filter passes by group tag
Filter passes by pass template UUID
Filter passes by pass template name. Must be URL encoded
Filter passes by event UUID
Filter passes by event name. Must be URL encoded
Returns passes created after given datetime. Format is ISO 8601
Returns passes created before given datetime. Format is ISO 8601. Can be combined with createdBefore parameter
Returns a partial response (Sparse fieldset) per record, instead of the whole record. Set one or many comma separated record attributes
If true, includes the pass design in the response
If true, includes the locations in the response if any are present
If true, includes the beacons in the response if any are present
Response
Successful
The response is of type object
.