Skip to main content
GET
/
api
/
billing
/
coworkertimepasses
/
{id}
{
  "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>"
}

​
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
Coworker Id.
​
BusinessId
integer
Business Id.
​
TimePassId
integer
Time Pass Id.
​
TimePassName
string
Time Pass Name.
​
TimePassCurrencyCode
string
Time Pass Currency Code.
​
Notes
string
Notes.
​
PurchaseOrder
string
Purchase Order.
​
Used
boolean
Used.
​
CheckedIn
boolean
Checked In.
​
UsedDate
string
Used Date.
​
RemainingUses
integer
Remaining Uses.
​
TotalUses
integer
Total Uses.
​
Free
boolean
Free.
​
Price
number
Price.
​
CreateMultiple
integer
Create Multiple.
​
ExpireDate
string
Expire Date.
​
Invoiced
boolean
Invoiced.
​
InvoiceDate
string
Invoice Date.
​
IsFromTariff
boolean
Is From Tariff.
​
IsPayAsYouGo
boolean
Is Pay As You Go.
​
TariffTimePassUniqueId
string
Tariff Time Pass Unique Id.
​
CoworkerProductUniqueId
string
Coworker Product Unique Id.
​
CoworkerContractUniqueId
string
Coworker Contract Unique Id.
​
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
}