Get one TimePass

GET

api

billing

timepasses

{id}

Get one TimePass

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

import requests

url = "https://spaces.nexudus.com/api/billing/timepasses/{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/timepasses/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "InvoiceLineDisplayAs": "<string>",
  "Price": 123,
  "MinutesIncluded": 123,
  "CountsTowardsPlanLimits": true,
  "UseAsPayAsYouGoForMembers": true,
  "UseAsPayAsYouGoForContacts": true,
  "UsePriority": 123,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxRateId": 123,
  "ReducedTaxRateId": 123,
  "ExemptTaxRateId": 123,
  "FinancialAccountId": 123,
  "Businesses": [
    123
  ],
  "KisiGroupId": "<string>",
  "DoorGuardGroupId": "<string>",
  "AccessControlGroupId": "<string>",
  "AccessControlGroupIds": "<string>",
  "AllowNetworkCheckIn": true,
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "Archived": true,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Passes allow customers to check in to a coworking space. There are two kinds:

Day Pass — valid for a single calendar day. Created with MinutesIncluded omitted (null). The customer can check in any number of times during that day.
Time Pass — valid across multiple days up to a fixed amount of time. Created with “MinutesIncluded <minutes> set. The customer can check in until the included minutes are exhausted.

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 TimePass-Read role.

Path Parameters

integer

required

The Id of the TimePass record to retrieve.

Code Examples

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

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

const record = await response.json();

import requests

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

record = response.json()

Response

200

integer

ID of the business linked to this record.

string

Business name.

string

Time pass name.

string

Invoice line display text.

number

Unit price amount.

integer

Minutes included.

boolean

Counts towards plan limits.

boolean

Use as pay-as-you-go for members.

boolean

Use as pay-as-you-go for contacts.

integer

Use priority.

integer

ID of the currency linked to this record.

string

Currency code.

integer

ID of the tax rate linked to this record.

integer

ID of the reduced tax rate linked to this record.

integer

ID of the exempt tax rate linked to this record.

integer

ID of the financial account linked to this record.

integer[]

List of businesses linked to this record.

string

Kisi group ID.

string

DoorGuard group ID.

string

ID of the access control group associated with this record.

string

The access control group ids value for this time pass.

boolean

Allow network check-in.

boolean

Only available for contacts.

boolean

Only available for members.

integer[]

List of tariffs linked to this record.

boolean

Whether this time pass is archived and hidden from active lists.

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

{
  "BusinessId": 0,
  "BusinessName": null,
  "Name": "",
  "InvoiceLineDisplayAs": null,
  "Price": 0,
  "MinutesIncluded": null,
  "CountsTowardsPlanLimits": false,
  "UseAsPayAsYouGoForMembers": false,
  "UseAsPayAsYouGoForContacts": false,
  "UsePriority": null,
  "CurrencyId": 0,
  "CurrencyCode": null,
  "TaxRateId": null,
  "ReducedTaxRateId": null,
  "ExemptTaxRateId": null,
  "FinancialAccountId": null,
  "Businesses": [],
  "KisiGroupId": null,
  "DoorGuardGroupId": null,
  "AccessControlGroupId": null,
  "AccessControlGroupIds": null,
  "AllowNetworkCheckIn": false,
  "OnlyForContacts": false,
  "OnlyForMembers": false,
  "Tariffs": [],
  "Archived": false,
  "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": "TimePass Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple TimePassesRetrieve multiple TimePass records by their Ids in a single request.

Get one TimePass

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

import requests

url = "https://spaces.nexudus.com/api/billing/timepasses/{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/timepasses/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "BusinessName": "<string>",
  "Name": "<string>",
  "InvoiceLineDisplayAs": "<string>",
  "Price": 123,
  "MinutesIncluded": 123,
  "CountsTowardsPlanLimits": true,
  "UseAsPayAsYouGoForMembers": true,
  "UseAsPayAsYouGoForContacts": true,
  "UsePriority": 123,
  "CurrencyId": 123,
  "CurrencyCode": "<string>",
  "TaxRateId": 123,
  "ReducedTaxRateId": 123,
  "ExemptTaxRateId": 123,
  "FinancialAccountId": 123,
  "Businesses": [
    123
  ],
  "KisiGroupId": "<string>",
  "DoorGuardGroupId": "<string>",
  "AccessControlGroupId": "<string>",
  "AccessControlGroupIds": "<string>",
  "AllowNetworkCheckIn": true,
  "OnlyForContacts": true,
  "OnlyForMembers": true,
  "Tariffs": [
    123
  ],
  "Archived": true,
  "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