Search CoworkerTimePasses

GET

api

billing

coworkertimepasses

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkertimepasses"

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', 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 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-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 customer assigned this pass.

integer

Filter by iD of the location that owns this pass.

integer

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

string

Filter by display value for TimePass.Name..

string

Filter by display value for TimePass.Currency.Code..

string

Filter by optional internal notes about this issued pass.

string

Filter by optional purchase-order reference for this pass.

boolean

Filter by whether the customer has used this pass; update-only operational status.

boolean

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

string

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

integer

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

integer

Filter by total number of included uses; calculated from the selected pass when issued.

boolean

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

number

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

integer

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

string

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

boolean

Filter by whether this pass has been invoiced; maintained by invoicing processing.

string

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

boolean

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

boolean

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

string

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

string

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

string

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

Range Filters

string

Filter by uTC timestamp when this pass was used; maintained by check-in processing greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC timestamp when this pass was used; maintained by check-in processing less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by remaining number of uses on this pass; initialized from the selected pass and consumed by check-ins unless pay-as-you-go greater than or equal to this value.

integer

Filter by remaining number of uses on this pass; initialized from the selected pass and consumed by check-ins unless pay-as-you-go less than or equal to this value.

integer

Filter by total number of included uses; calculated from the selected pass when issued greater than or equal to this value.

integer

Filter by total number of included uses; calculated from the selected pass when issued less than or equal to this value.

number

Filter by optional monetary price override for this issued pass; when omitted, the selected pass calculates the price for the customer greater than or equal to this value.

number

Filter by optional monetary price override for this issued pass; when omitted, the selected pass calculates the price for the customer less than or equal to this value.

integer

Filter by number of identical passes to issue in this request, including this one; a customer cannot hold more than 500 passes greater than or equal to this value.

integer

Filter by number of identical passes to issue in this request, including this one; a customer cannot hold more than 500 passes less than or equal to this value.

string

Filter by optional UTC expiration date and time; an expired pass is excluded from access-control updates greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC expiration date and time; an expired pass is excluded from access-control updates less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC timestamp when this pass was invoiced; maintained by invoicing processing greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by uTC timestamp when this pass was invoiced; maintained by invoicing processing less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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/coworkertimepasses?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

const data = await response.json();

import requests

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

data = response.json()

Filtering by CreatedOn

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

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

const data = await response.json();

import requests

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

data = response.json()

Range filters

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

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkertimepasses?' + new URLSearchParams({
    from_CoworkerTimePass_UpdatedOn: '2025-01-01T00:00',
    to_CoworkerTimePass_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/coworkertimepasses',
    params={
        'from_CoworkerTimePass_UpdatedOn': '2025-01-01T00:00',
        'to_CoworkerTimePass_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

CoworkerTimePass[]

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

Partial records — The listing endpoint returns a summary representation of each CoworkerTimePass. The following fields are not populated in the Records[] response: Notes, PurchaseOrder, Free, CreateMultiple.To get all fields, fetch the full record using the Get one CoworkerTimePass 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.

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": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "TimePassId": 0,
      "TimePassName": null,
      "TimePassCurrencyCode": null,
      "Used": false,
      "CheckedIn": false,
      "UsedDate": null,
      "RemainingUses": null,
      "TotalUses": null,
      "Price": null,
      "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
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "CreatedOn",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Search CoworkerTimePasses

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

import requests

url = "https://spaces.nexudus.com/api/billing/coworkertimepasses"

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', 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 CreatedOn

Range filters

Response

200

​Authentication

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200