Search CoworkerTimePasses - Nexudus Platform

GET

api

billing

coworkertimepasses

Search CoworkerTimePasses

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

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

A CoworkerTimePass represents a time pass assigned to a customer. Time passes can be assigned directly, granted by a product purchase (CoworkerProductUniqueId), or included in a pricing plan (TariffTimePassUniqueId). Each time pass tracks its usage status (Used, UsedDate), remaining and total uses, and whether the customer is currently checked in. Time passes may have an expiration date and can be free or priced. Use CreateMultiple when creating to issue several time passes at once. The IsFromTariff and IsPayAsYouGo flags indicate the origin and billing model of the time pass.

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

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. 0 for ascending, 1 for descending.

Filters

CoworkerTimePass_Coworker

integer

Filter by the customer who owns this time pass.

CoworkerTimePass_Business

integer

Filter by the business (location) this time pass belongs to.

CoworkerTimePass_TimePass

integer

Filter by the time pass definition this is an instance of.

CoworkerTimePass_TimePass_Name

string

Filter by name of the linked time pass.

CoworkerTimePass_TimePass_Currency_Code

string

Filter by currency code of the linked time pass.

CoworkerTimePass_Notes

string

Filter by optional notes for this time pass.

CoworkerTimePass_PurchaseOrder

string

Filter by purchase order reference.

CoworkerTimePass_Used

boolean

Filter by whether this time pass has been used.

CoworkerTimePass_CheckedIn

boolean

Filter by whether the customer is currently checked in with this time pass.

CoworkerTimePass_UsedDate

string

Filter by date when this time pass was used.

CoworkerTimePass_RemainingUses

integer

Filter by number of remaining uses on this time pass.

CoworkerTimePass_TotalUses

integer

Filter by total number of uses allowed on this time pass.

CoworkerTimePass_Free

boolean

Filter by whether this time pass is free of charge.

CoworkerTimePass_Price

number

Filter by custom price for this time pass.

CoworkerTimePass_CreateMultiple

integer

Filter by number of time passes to create at once.

CoworkerTimePass_ExpireDate

string

Filter by expiration date for this time pass.

CoworkerTimePass_Invoiced

boolean

Filter by whether this time pass has been invoiced.

CoworkerTimePass_InvoiceDate

string

Filter by date when this time pass was invoiced.

CoworkerTimePass_IsFromTariff

boolean

Filter by whether this time pass was granted by a pricing plan (tariff).

CoworkerTimePass_IsPayAsYouGo

boolean

Filter by whether this is a pay-as-you-go time pass.

CoworkerTimePass_TariffTimePassUniqueId

string

Filter by unique identifier linking this time pass to a tariff time pass allocation.

CoworkerTimePass_CoworkerProductUniqueId

string

Filter by unique identifier linking this time pass to a customer product purchase.

CoworkerTimePass_CoworkerContractUniqueId

string

Filter by unique identifier linking this time pass to a customer contract.

Range Filters

from_CoworkerTimePass_UsedDate

string

Filter by date when this time pass was used greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerTimePass_UsedDate

string

Filter by date when this time pass was used less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerTimePass_RemainingUses

integer

Filter by number of remaining uses on this time pass greater than or equal to this value.

to_CoworkerTimePass_RemainingUses

integer

Filter by number of remaining uses on this time pass less than or equal to this value.

from_CoworkerTimePass_TotalUses

integer

Filter by total number of uses allowed on this time pass greater than or equal to this value.

to_CoworkerTimePass_TotalUses

integer

Filter by total number of uses allowed on this time pass less than or equal to this value.

from_CoworkerTimePass_Price

number

Filter by custom price for this time pass greater than or equal to this value.

to_CoworkerTimePass_Price

number

Filter by custom price for this time pass less than or equal to this value.

from_CoworkerTimePass_CreateMultiple

integer

Filter by number of time passes to create at once greater than or equal to this value.

to_CoworkerTimePass_CreateMultiple

integer

Filter by number of time passes to create at once less than or equal to this value.

from_CoworkerTimePass_ExpireDate

string

Filter by expiration date for this time pass greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerTimePass_ExpireDate

string

Filter by expiration date for this time pass less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerTimePass_InvoiceDate

string

Filter by date when this time pass was invoiced greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CoworkerTimePass_InvoiceDate

string

Filter by date when this time pass was invoiced less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CoworkerTimePass_CreatedOn

string

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

to_CoworkerTimePass_CreatedOn

string

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

from_CoworkerTimePass_UpdatedOn

string

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

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

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"

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"

Response

200

Records

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, Price, 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.

CurrentPage

integer

Current page number.

CurrentPageSize

integer

Number of records per page.

CurrentOrderField

string

The field used for sorting.

CurrentSortDirection

integer

The sort direction (0 = 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": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "TimePassId": 0,
      "TimePassName": null,
      "TimePassCurrencyCode": null,
      "Used": false,
      "CheckedIn": false,
      "UsedDate": null,
      "RemainingUses": null,
      "TotalUses": 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
}

Get one CoworkerTimePassRetrieve a single CoworkerTimePass record by its Id.

Search CoworkerTimePasses

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

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

Documentation Index

​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