Get one CoworkerTimePass

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>'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkertimepasses/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/coworkertimepasses/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

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"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkertimepasses/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/coworkertimepasses/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

The customer who owns this time pass.

integer

The business (location) this time pass belongs to.

integer

The time pass definition this is an instance of.

string

Name of the linked time pass.

string

Currency code of the linked time pass.

string

Optional notes for this time pass.

string

Purchase order reference.

boolean

Whether this time pass has been used.

boolean

Whether the customer is currently checked in with this time pass.

string

Date when this time pass was used.

integer

Number of remaining uses on this time pass.

integer

Total number of uses allowed on this time pass.

boolean

Whether this time pass is free of charge.

number

Custom price for this time pass.

integer

Number of time passes to create at once.

string

Expiration date for this time pass.

boolean

Whether this time pass has been invoiced.

string

Date when this time pass was invoiced.

boolean

Whether this time pass was granted by a pricing plan (tariff).

boolean

Whether this is a pay-as-you-go time pass.

string

Unique identifier linking this time pass to a tariff time pass allocation.

string

Unique identifier linking this time pass to a customer product purchase.

string

Unique identifier linking this time pass to a customer contract.

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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
}

Get multiple CoworkerTimePassesRetrieve multiple CoworkerTimePass records by their Ids in a single request.

Get one CoworkerTimePass

curl --request GET \
  --url https://spaces.nexudus.com/api/billing/coworkertimepasses/{id} \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/billing/coworkertimepasses/{id}"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/billing/coworkertimepasses/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200