CoworkerTimePasses
Get one CoworkerTimePass
Retrieve a single CoworkerTimePass record by its Id.
GET
Get one CoworkerTimePass
A customer pass (CoworkerTimePass) is an issued check-in allowance for a customer, tracking its remaining uses, use status, price, expiry, and invoicing status.
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 CoworkerTimePass-Read role.Path Parameters
Code Examples
Response
200
ID of the pass definition to issue; it determines the included number of uses and default price.
Whether the customer currently has an open check-in using this pass; maintained by check-in processing.
Remaining number of uses on this pass; initialized from the selected pass and consumed by check-ins unless pay-as-you-go.
Optional monetary price override for this issued pass; when omitted, the selected pass calculates the price for the customer.
Number of identical passes to issue in this request, including this one; a customer cannot hold more than 500 passes.
Optional UTC expiration date and time; an expired pass is excluded from access-control updates.
Whether this pass was granted by the customer’s plan rather than issued manually or from a product purchase.
Whether this is a pay-as-you-go pass; pay-as-you-go passes remain active even when no remaining uses are recorded.
Internal GUID linking this pass to the plan allocation that created it; do not set or use this field.
Internal GUID linking this pass to the customer product purchase that created it; do not set or use this field.
Internal GUID linking this pass to the customer contract that created it; do not set or use this field.
Example Response