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

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

ID of the customer assigned this pass.

integer

ID of the location that owns this pass.

integer

ID of the pass definition to issue; it determines the included number of uses and default price.

string

Display value for TimePass.Name..

string

Display value for TimePass.Currency.Code..

string

Optional internal notes about this issued pass.

string

Optional purchase-order reference for this pass.

boolean

Whether the customer has used this pass; update-only operational status.

boolean

Whether the customer currently has an open check-in using this pass; maintained by check-in processing.

string

UTC timestamp when this pass was used; maintained by check-in processing.

integer

Remaining number of uses on this pass; initialized from the selected pass and consumed by check-ins unless pay-as-you-go.

integer

Total number of included uses; calculated from the selected pass when issued.

boolean

Whether no charge is due for this issued pass; when true its calculated price is zero.

number

Optional monetary price override for this issued pass; when omitted, the selected pass calculates the price for the customer.

integer

Number of identical passes to issue in this request, including this one; a customer cannot hold more than 500 passes.

string

Optional UTC expiration date and time; an expired pass is excluded from access-control updates.

boolean

Whether this pass has been invoiced; maintained by invoicing processing.

string

UTC timestamp when this pass was invoiced; maintained by invoicing processing.

boolean

Whether this pass was granted by the customer’s plan rather than issued manually or from a product purchase.

boolean

Whether this is a pay-as-you-go pass; pay-as-you-go passes remain active even when no remaining uses are recorded.

string

Internal GUID linking this pass to the plan allocation that created it; do not set or use this field.

string

Internal GUID linking this pass to the customer product purchase that created it; do not set or use this field.

string

Internal GUID linking this pass to the customer contract that created it; do not set or use this field.

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