Search TimePasses

GET

api

billing

timepasses

Search TimePasses

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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-List role.

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the location that owns this pass and supplies its default location scope and local check-in schedule..

string

Filter by display value for Business.Name..

string

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

string

Filter by optional custom text shown on invoice lines instead of the pass name..

number

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

integer

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

boolean

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

boolean

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

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

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

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

string

Filter by display value for Currency.Code..

integer

Filter by optional ID of the standard tax rate applied when this pass is invoiced..

string

Filter by display value for TaxRate.Name..

integer

Filter by optional ID of the reduced tax rate applied when the customer qualifies for reduced taxation..

integer

Filter by optional ID of the tax rate applied when the customer is tax exempt..

integer

Filter by optional ID of the financial account used to record pass revenue..

string

Filter by display value for FinancialAccount.Name..

string

Filter by optional external Kisi access-control group ID assigned to customers using this pass..

string

Filter by optional external DoorGuard access-control group ID assigned to customers using this pass..

string

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

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

boolean

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

boolean

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

boolean

Filter by 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..

boolean

Filter by whether this pass is archived and should no longer appear in active pass lists..

Range Filters

number

Filter by base amount charged in the selected currency; the lowest matching plan-specific special price overrides this amount for eligible members. greater than or equal to this value.

number

Filter by base amount charged in the selected currency; the lowest matching plan-specific special price overrides this amount for eligible members. less than or equal to this value.

integer

Filter by non-negative total check-in allowance in minutes; leave null for a day pass that can be used repeatedly during one calendar day. greater than or equal to this value.

integer

Filter by non-negative total check-in allowance in minutes; leave null for a day pass that can be used repeatedly during one calendar day. less than or equal to this value.

integer

Filter by optional pass-selection priority when a customer has multiple valid passes; higher values are used first and null is treated as normal priority (0). greater than or equal to this value.

integer

Filter by optional pass-selection priority when a customer has multiple valid passes; higher values are used first and null is treated as normal priority (0). less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/billing/timepasses?page=1&size=15&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/timepasses?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Name',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/timepasses',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Name

curl -X GET \
  "https://spaces.nexudus.com/api/billing/timepasses?TimePass_Name=example-value&orderBy=Name&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/timepasses?' + new URLSearchParams({
    TimePass_Name: 'example-value',
    orderBy: 'Name',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/timepasses',
    params={
        'TimePass_Name': 'example-value',
        'orderBy': 'Name',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/billing/timepasses?from_TimePass_UpdatedOn=2025-01-01T00:00&to_TimePass_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/timepasses?' + new URLSearchParams({
    from_TimePass_UpdatedOn: '2025-01-01T00:00',
    to_TimePass_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/billing/timepasses',
    params={
        'from_TimePass_UpdatedOn': '2025-01-01T00:00',
        'to_TimePass_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

TimePass[]

The list of TimePass records matching the query. See the Get one TimePass endpoint for the full list of properties returned for each record.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search TimePasses

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

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

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

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Name

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Name

Range filters

Response

200