Skip to main content
GET
/
api
/
billing
/
coworkertimepasses
{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

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

​
Filters

​
CoworkerTimePass_Coworker
integer
Filter by Coworker Id.
​
CoworkerTimePass_Business
integer
Filter by Business Id.
​
CoworkerTimePass_TimePass
integer
Filter by Time Pass Id.
​
CoworkerTimePass_TimePass_Name
string
Filter by Time Pass Name.
​
CoworkerTimePass_TimePass_Currency_Code
string
Filter by Time Pass Currency Code.
​
CoworkerTimePass_Notes
string
Filter by Notes.
​
CoworkerTimePass_PurchaseOrder
string
Filter by Purchase Order.
​
CoworkerTimePass_Used
boolean
Filter by Used.
​
CoworkerTimePass_CheckedIn
boolean
Filter by Checked In.
​
CoworkerTimePass_UsedDate
string
Filter by Used Date.
​
CoworkerTimePass_RemainingUses
integer
Filter by Remaining Uses.
​
CoworkerTimePass_TotalUses
integer
Filter by Total Uses.
​
CoworkerTimePass_Free
boolean
Filter by Free.
​
CoworkerTimePass_Price
number
Filter by Price.
​
CoworkerTimePass_CreateMultiple
integer
Filter by Create Multiple.
​
CoworkerTimePass_ExpireDate
string
Filter by Expire Date.
​
CoworkerTimePass_Invoiced
boolean
Filter by Invoiced.
​
CoworkerTimePass_InvoiceDate
string
Filter by Invoice Date.
​
CoworkerTimePass_IsFromTariff
boolean
Filter by Is From Tariff.
​
CoworkerTimePass_IsPayAsYouGo
boolean
Filter by Is Pay As You Go.
​
CoworkerTimePass_TariffTimePassUniqueId
string
Filter by Tariff Time Pass Unique Id.
​
CoworkerTimePass_CoworkerProductUniqueId
string
Filter by Coworker Product Unique Id.
​
CoworkerTimePass_CoworkerContractUniqueId
string
Filter by Coworker Contract Unique Id.

​
Range Filters

​
from_CoworkerTimePass_UsedDate
string
Filter by used date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerTimePass_UsedDate
string
Filter by used date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerTimePass_RemainingUses
integer
Filter by remaining uses greater than or equal to this value.
​
to_CoworkerTimePass_RemainingUses
integer
Filter by remaining uses less than or equal to this value.
​
from_CoworkerTimePass_TotalUses
integer
Filter by total uses greater than or equal to this value.
​
to_CoworkerTimePass_TotalUses
integer
Filter by total uses less than or equal to this value.
​
from_CoworkerTimePass_Price
number
Filter by price greater than or equal to this value.
​
to_CoworkerTimePass_Price
number
Filter by price less than or equal to this value.
​
from_CoworkerTimePass_CreateMultiple
integer
Filter by create multiple greater than or equal to this value.
​
to_CoworkerTimePass_CreateMultiple
integer
Filter by create multiple less than or equal to this value.
​
from_CoworkerTimePass_ExpireDate
string
Filter by expire date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerTimePass_ExpireDate
string
Filter by expire date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
from_CoworkerTimePass_InvoiceDate
string
Filter by invoice date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.
​
to_CoworkerTimePass_InvoiceDate
string
Filter by invoice date 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=1" \
  -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=1" \
  -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=-1" \
  -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 included 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 (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": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "TimePassId": 0,
      "TimePassName": null,
      "TimePassCurrencyCode": null,
      "Notes": null,
      "PurchaseOrder": null,
      "Used": false,
      "CheckedIn": false,
      "UsedDate": null,
      "RemainingUses": null,
      "TotalUses": null,
      "Free": false,
      "Price": null,
      "CreateMultiple": 0,
      "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
}