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,
  "TaxRateName": "<string>",
  "ReducedTaxRateId": 123,
  "ExemptTaxRateId": 123,
  "FinancialAccountId": 123,
  "FinancialAccountName": "<string>",
  "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>"
}

A Pass (internally TimePass) is a prepaid check-in allowance for a location, configured as either a day pass or a time-limited pass with availability, customer, pricing, and access-control rules.

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 location that owns this pass and supplies its default location scope and local check-in schedule..

string

Display value for Business.Name..

string

Required pass name, up to 254 characters; this is the customer-facing name used to identify the pass..

string

Optional custom text shown on invoice lines instead of the pass name..

number

Base amount charged in the selected currency; the lowest matching plan-specific special price overrides this amount for eligible members..

integer

Non-negative total check-in allowance in minutes; leave null for a day pass that can be used repeatedly during one calendar day..

boolean

Whether check-ins made with this pass count against the customer’s plan check-in and time limits..

boolean

Whether this pass can be automatically sold to members who check in without a valid pass when pay-as-you-go check-in is enabled..

boolean

Whether this pass can be automatically sold to contacts without an active contract who check in without a valid pass when pay-as-you-go check-in is enabled..

integer

Optional pass-selection priority when a customer has multiple valid passes; higher values are used first and null is treated as normal priority (0)..

integer

ID of the ISO 4217 currency used for the pass price and plan-specific special prices..

string

Display value for Currency.Code..

integer

Optional ID of the standard tax rate applied when this pass is invoiced..

string

Display value for TaxRate.Name..

integer

Optional ID of the reduced tax rate applied when the customer qualifies for reduced taxation..

integer

Optional ID of the tax rate applied when the customer is tax exempt..

integer

Optional ID of the financial account used to record pass revenue..

string

Display value for FinancialAccount.Name..

integer[]

List of locations where this pass can be used; when empty, it is valid at the owning location and its child locations, while a non-empty list restricts use to those locations..

string

Optional external Kisi access-control group ID assigned to customers using this pass..

string

Optional external DoorGuard access-control group ID assigned to customers using this pass..

string

Legacy single access-control group ID; do not use this field because provider-specific access groups are managed through the current access-control integration..

string

Internal serialized mapping of access-control providers to external group IDs; managed by access-control integrations and not directly editable..

boolean

Whether a customer holding this pass can check in to the location’s connected IT network..

boolean

Whether this pass is restricted to contacts without an active contract; do not combine with OnlyForMembers..

boolean

Whether this pass is restricted to members with an active contract; when Tariffs is non-empty, the member must have an active contract on one of those plans, and this must not be combined with OnlyForContacts..

integer[]

List of plans whose active members can use this pass when OnlyForMembers is true; an empty list allows members on any plan..

boolean

Whether this pass is archived and should no longer appear in active pass 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,
  "TaxRateName": null,
  "ReducedTaxRateId": null,
  "ExemptTaxRateId": null,
  "FinancialAccountId": null,
  "FinancialAccountName": 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 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,
  "TaxRateName": "<string>",
  "ReducedTaxRateId": 123,
  "ExemptTaxRateId": 123,
  "FinancialAccountId": 123,
  "FinancialAccountName": "<string>",
  "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