TimePasses
Search TimePasses
Search and list TimePass records with filtering, sorting, and pagination.
GET
Search TimePasses
A Pass (internally TimePass) is a prepaid check-in allowance for a location, configured as either a day pass or a time-limited pass with availability, customer, pricing, and access-control rules.
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the TimePass-List role.Query Parameters
Pagination & Sorting
Filters
Filter by iD of the location that owns this pass and supplies its default location scope and local check-in schedule..
Filter by required pass name, up to 254 characters; this is the customer-facing name used to identify the pass..
Filter by base amount charged in the selected currency; the lowest matching plan-specific special price overrides this amount for eligible members..
Filter by non-negative total check-in allowance in minutes; leave null for a day pass that can be used repeatedly during one calendar day..
Filter by whether check-ins made with this pass count against the customer’s plan check-in and time limits..
Filter by whether this pass can be automatically sold to members who check in without a valid pass when pay-as-you-go check-in is enabled..
Filter by whether this pass can be automatically sold to contacts without an active contract who check in without a valid pass when pay-as-you-go check-in is enabled..
Filter by optional pass-selection priority when a customer has multiple valid passes; higher values are used first and null is treated as normal priority (0)..
Filter by iD of the ISO 4217 currency used for the pass price and plan-specific special prices..
Filter by optional ID of the reduced tax rate applied when the customer qualifies for reduced taxation..
Filter by optional external Kisi access-control group ID assigned to customers using this pass..
Filter by optional external DoorGuard access-control group ID assigned to customers using this pass..
Filter by legacy single access-control group ID; do not use this field because provider-specific access groups are managed through the current access-control integration..
Filter by internal serialized mapping of access-control providers to external group IDs; managed by access-control integrations and not directly editable..
Filter by whether a customer holding this pass can check in to the location’s connected IT network..
Filter by whether this pass is restricted to contacts without an active contract; do not combine with OnlyForMembers..
Filter by whether this pass is restricted to members with an active contract; when Tariffs is non-empty, the member must have an active contract on one of those plans, and this must not be combined with OnlyForContacts..
Range Filters
Filter by base amount charged in the selected currency; the lowest matching plan-specific special price overrides this amount for eligible members. greater than or equal to this value.
Filter by base amount charged in the selected currency; the lowest matching plan-specific special price overrides this amount for eligible members. less than or equal to this value.
Filter by non-negative total check-in allowance in minutes; leave null for a day pass that can be used repeatedly during one calendar day. greater than or equal to this value.
Filter by non-negative total check-in allowance in minutes; leave null for a day pass that can be used repeatedly during one calendar day. less than or equal to this value.
Filter by optional pass-selection priority when a customer has multiple valid passes; higher values are used first and null is treated as normal priority (0). greater than or equal to this value.
Filter by optional pass-selection priority when a customer has multiple valid passes; higher values are used first and null is treated as normal priority (0). less than or equal to this value.
Code Examples
Simple listing
Filtering by Name
Range filters
Response
200
The list of TimePass records matching the query. See the Get one TimePass endpoint for the full list of properties returned for each record.
Example Response