Skip to main content
GET
/
api
/
billing
/
timepasses
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}
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-List role.

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 1 for ascending, -1 for descending.

​
Filters

​
TimePass_Business
integer
Filter by Business Id.
​
TimePass_Business_Name
string
Filter by business name.
​
TimePass_Name
string
Filter by time pass name.
​
TimePass_InvoiceLineDisplayAs
string
Filter by invoice line display text.
​
TimePass_Price
number
Filter by price.
​
TimePass_MinutesIncluded
integer
Filter by minutes included.
​
TimePass_CountsTowardsPlanLimits
boolean
Filter by counts towards plan limits.
​
TimePass_UseAsPayAsYouGoForMembers
boolean
Filter by use as pay-as-you-go for members.
​
TimePass_UseAsPayAsYouGoForContacts
boolean
Filter by use as pay-as-you-go for contacts.
​
TimePass_UsePriority
integer
Filter by use priority.
​
TimePass_Currency
integer
Filter by Currency Id.
​
TimePass_Currency_Code
string
Filter by currency code.
​
TimePass_TaxRate
integer
Filter by Tax Rate Id.
​
TimePass_ReducedTaxRate
integer
Filter by Reduced Tax Rate Id.
​
TimePass_ExemptTaxRate
integer
Filter by Exempt Tax Rate Id.
​
TimePass_FinancialAccount
integer
Filter by Financial Account Id.
​
TimePass_KisiGroupId
string
Filter by kisi group ID.
​
TimePass_DoorGuardGroupId
string
Filter by doorGuard group ID.
​
TimePass_AccessControlGroupId
string
Filter by Access Control Group Id.
​
TimePass_AccessControlGroupIds
string
Filter by Access Control Group Ids.
​
TimePass_AllowNetworkCheckIn
boolean
Filter by allow network check-in.
​
TimePass_OnlyForContacts
boolean
Filter by only available for contacts.
​
TimePass_OnlyForMembers
boolean
Filter by only available for members.
​
TimePass_Archived
boolean
Filter by archived.

​
Range Filters

​
from_TimePass_Price
number
Filter by price greater than or equal to this value.
​
to_TimePass_Price
number
Filter by price less than or equal to this value.
​
from_TimePass_MinutesIncluded
integer
Filter by minutes included greater than or equal to this value.
​
to_TimePass_MinutesIncluded
integer
Filter by minutes included less than or equal to this value.
​
from_TimePass_UsePriority
integer
Filter by use priority greater than or equal to this value.
​
to_TimePass_UsePriority
integer
Filter by use priority less than or equal to this value.
​
from_TimePass_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_TimePass_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_TimePass_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_TimePass_UpdatedOn
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=1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Filtering by Name

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

​
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=-1" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Records
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.
Partial records — The listing endpoint returns a summary representation of each TimePass. The following fields are not included in the Records[] response: CountsTowardsPlanLimits, OnlyForContacts, OnlyForMembers.To get all fields, fetch the full record using the Get one TimePass endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (1 = ascending, -1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
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,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Name",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}