Search CoworkerBookingCredits

GET

api

billing

coworkerbookingcredits

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

import requests

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

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/coworkerbookingcredits', 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 booking credit (internally CoworkerBookingCredit) is a monetary balance assigned to a customer that can pay for bookings, event sign-ups, or, when universal credit is enabled, products, plans, passes, and selected one-off charges. It can be created manually or released from a plan or product benefit, and its availability can be limited by eligibility and a validity period.

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 CoworkerBookingCredit-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 this booking credit belongs to.

string

Filter by display value for Coworker.FullName..

integer

Filter by iD of the location that issued and owns this booking credit.

string

Filter by display value for Business.Name..

string

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

string

Filter by optional operator-facing label or description for this booking credit.

integer

Filter by read-only ID of the plan booking-credit definition that created this credit, if applicable.

string

Filter by display value for TariffBookingCredit.Name..

number

Filter by read-only monetary amount still available; the system initializes it from TotalCredit and changes it through credit use or an adjustment.

number

Filter by total monetary amount assigned when this credit is created; it sets the initial RemainingCredit.

string

Filter by optional UTC date and time when this credit becomes usable; blank means it is usable immediately.

string

Filter by optional UTC date and time when this credit stops being usable; blank means no expiry, and when set it must be later than ValidFrom.

boolean

Filter by whether this credit can pay for bookings; use ElegibleResourceTypes to limit eligible resource types.

boolean

Filter by whether this credit can pay for event sign-ups; use EventCategories to limit eligible event categories.

boolean

Filter by whether this credit can pay for products, plans, passes, and eligible charges; use the eligibility lists and AppliesToCharges to restrict those uses.

string

Filter by internal unique ID linking this credit to the product purchase that created it.

boolean

Filter by system-calculated flag indicating whether any eligible resource type has a booking rate with a credit price.

string

Filter by internal unique ID linking this credit to the contract that originated it.

boolean

Filter by whether this universal credit can pay for one-off charges in addition to products, plans, and passes.

Range Filters

number

Filter by read-only monetary amount still available; the system initializes it from TotalCredit and changes it through credit use or an adjustment greater than or equal to this value.

number

Filter by read-only monetary amount still available; the system initializes it from TotalCredit and changes it through credit use or an adjustment less than or equal to this value.

number

Filter by total monetary amount assigned when this credit is created; it sets the initial RemainingCredit greater than or equal to this value.

number

Filter by total monetary amount assigned when this credit is created; it sets the initial RemainingCredit less than or equal to this value.

string

Filter by optional UTC date and time when this credit becomes usable; blank means it is usable immediately greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time when this credit becomes usable; blank means it is usable immediately less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time when this credit stops being usable; blank means no expiry, and when set it must be later than ValidFrom greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by optional UTC date and time when this credit stops being usable; blank means no expiry, and when set it must be later than ValidFrom 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/coworkerbookingcredits?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerbookingcredits?' + 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/coworkerbookingcredits',
    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/coworkerbookingcredits?CoworkerBookingCredit_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/billing/coworkerbookingcredits?' + new URLSearchParams({
    CoworkerBookingCredit_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/coworkerbookingcredits',
    params={
        'CoworkerBookingCredit_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/coworkerbookingcredits?from_CoworkerBookingCredit_UpdatedOn=2025-01-01T00:00&to_CoworkerBookingCredit_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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

data = response.json()

Response

200

CoworkerBookingCredit[]

The list of CoworkerBookingCredit records matching the query. See the Get one CoworkerBookingCredit 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": [
    {
      "CoworkerId": 0,
      "CoworkerFullName": null,
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "Description": null,
      "TariffBookingCreditId": null,
      "TariffBookingCreditName": null,
      "ElegibleResourceTypes": [],
      "ElegibleProducts": [],
      "ElegibleTariffs": [],
      "RemainingCredit": 0,
      "TotalCredit": 0,
      "ValidFrom": null,
      "ExpireDate": null,
      "CaneBeUsedForBookings": false,
      "CaneBeUsedForEvents": false,
      "EventCategories": [],
      "IsUniversalCredit": false,
      "CoworkerProductUniqueId": null,
      "UseCreditPrice": false,
      "CoworkerContractUniqueId": null,
      "ElegiblePasses": [],
      "AppliesToCharges": 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": "CoworkerBookingCredit 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 CoworkerBookingCredits

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

import requests

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

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/coworkerbookingcredits', 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

Search CoworkerBookingCredits

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