Skip to main content
GET
/
api
/
billing
/
coworkertimepasses
/
{id}
Get one CoworkerTimePass
curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkertimepasses/{id} \
  --header 'Authorization: Basic <encoded-value>'
{
  "CoworkerId": 123,
  "BusinessId": 123,
  "TimePassId": 123,
  "TimePassName": "<string>",
  "TimePassCurrencyCode": "<string>",
  "Notes": "<string>",
  "PurchaseOrder": "<string>",
  "Used": true,
  "CheckedIn": true,
  "UsedDate": "<string>",
  "RemainingUses": 123,
  "TotalUses": 123,
  "Free": true,
  "Price": 123,
  "CreateMultiple": 123,
  "ExpireDate": "<string>",
  "Invoiced": true,
  "InvoiceDate": "<string>",
  "IsFromTariff": true,
  "IsPayAsYouGo": true,
  "TariffTimePassUniqueId": "<string>",
  "CoworkerProductUniqueId": "<string>",
  "CoworkerContractUniqueId": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
A CoworkerTimePass represents a time pass assigned to a customer. Time passes can be assigned directly, granted by a product purchase (CoworkerProductUniqueId), or included in a pricing plan (TariffTimePassUniqueId). Each time pass tracks its usage status (Used, UsedDate), remaining and total uses, and whether the customer is currently checked in. Time passes may have an expiration date and can be free or priced. Use CreateMultiple when creating to issue several time passes at once. The IsFromTariff and IsPayAsYouGo flags indicate the origin and billing model of the time pass.

​
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

​
id
integer
required
The Id of the CoworkerTimePass record to retrieve.

​
Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/billing/coworkertimepasses/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
CoworkerId
integer
The customer who owns this time pass.
​
BusinessId
integer
The business (location) this time pass belongs to.
​
TimePassId
integer
The time pass definition this is an instance of.
​
TimePassName
string
Name of the linked time pass.
​
TimePassCurrencyCode
string
Currency code of the linked time pass.
​
Notes
string
Optional notes for this time pass.
​
PurchaseOrder
string
Purchase order reference.
​
Used
boolean
Whether this time pass has been used.
​
CheckedIn
boolean
Whether the customer is currently checked in with this time pass.
​
UsedDate
string
Date when this time pass was used.
​
RemainingUses
integer
Number of remaining uses on this time pass.
​
TotalUses
integer
Total number of uses allowed on this time pass.
​
Free
boolean
Whether this time pass is free of charge.
​
Price
number
Custom price for this time pass.
​
CreateMultiple
integer
Number of time passes to create at once.
​
ExpireDate
string
Expiration date for this time pass.
​
Invoiced
boolean
Whether this time pass has been invoiced.
​
InvoiceDate
string
Date when this time pass was invoiced.
​
IsFromTariff
boolean
Whether this time pass was granted by a pricing plan (tariff).
​
IsPayAsYouGo
boolean
Whether this is a pay-as-you-go time pass.
​
TariffTimePassUniqueId
string
Unique identifier linking this time pass to a tariff time pass allocation.
​
CoworkerProductUniqueId
string
Unique identifier linking this time pass to a customer product purchase.
​
CoworkerContractUniqueId
string
Unique identifier linking this time pass to a customer contract.
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
string
External system identifier.
Example Response
{
  "CoworkerId": 0,
  "BusinessId": 0,
  "TimePassId": 0,
  "TimePassName": null,
  "TimePassCurrencyCode": null,
  "Notes": null,
  "PurchaseOrder": null,
  "Used": false,
  "CheckedIn": false,
  "UsedDate": null,
  "RemainingUses": null,
  "TotalUses": null,
  "Free": false,
  "Price": null,
  "CreateMultiple": 0,
  "ExpireDate": null,
  "Invoiced": false,
  "InvoiceDate": null,
  "IsFromTariff": false,
  "IsPayAsYouGo": false,
  "TariffTimePassUniqueId": null,
  "CoworkerProductUniqueId": null,
  "CoworkerContractUniqueId": null,
  "Id": 87654321,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "CreatedOn": "2025-01-10T08:00:00Z",
  "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "UpdatedBy": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CoworkerTimePass Example",
  "LocalizationDetails": null,
  "CustomFields": null
}