Search CoworkerBookingCreditUseHistories

GET

api

billing

coworkerbookingcreditusehistories

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

import requests

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

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/coworkerbookingcreditusehistories', 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 CoworkerBookingCreditUseHistory records each time a CoworkerBookingCredit was consumed. Each entry captures the amount of credit deducted and links back to the booking, event attendance, or invoice line that triggered the use. Use the read-only denormalised fields (BookingFromTime, BookingResourceName, EventAttendeeCalendarEventName, etc.) to inspect what the credit was spent on without needing to fetch the related records separately.

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 CoworkerBookingCreditUseHistory-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

string

Filter by optional description or note for this credit use entry.

integer

Filter by iD of the booking credit that was consumed.

integer

Filter by iD of the booking this credit was applied to, if the credit was used for a booking.

string

Filter by start time of the booking.

string

Filter by end time of the booking.

string

Filter by name of the resource that was booked.

integer

Filter by iD of the invoice line this credit was applied to, if the credit was used against an invoice.

integer

Filter by iD of the invoice containing the linked invoice line.

string

Filter by invoice number of the invoice containing the linked invoice line.

integer

Filter by iD of the event attendance record this credit was applied to, if the credit was used for an event.

string

Filter by name of the calendar event the credit was used for.

string

Filter by name of the event ticket product purchased by the attendee.

string

Filter by full name of the event attendee.

string

Filter by email address of the event attendee.

number

Filter by amount of credit consumed by this entry.

Range Filters

string

Filter by start time of the booking greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by start time of the booking less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by end time of the booking greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by end time of the booking less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

integer

Filter by iD of the invoice containing the linked invoice line greater than or equal to this value.

integer

Filter by iD of the invoice containing the linked invoice line less than or equal to this value.

number

Filter by amount of credit consumed by this entry greater than or equal to this value.

number

Filter by amount of credit consumed by this entry less than or equal to this value.

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

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

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

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

data = response.json()

Response

200

CoworkerBookingCreditUseHistory[]

The list of CoworkerBookingCreditUseHistory records matching the query. See the Get one CoworkerBookingCreditUseHistory 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": [
    {
      "Description": null,
      "CoworkerBookingCreditId": 0,
      "BookingId": null,
      "BookingFromTime": null,
      "BookingToTime": null,
      "BookingResourceName": null,
      "CoworkerInvoiceLineId": null,
      "CoworkerInvoiceLineCoworkerInvoiceId": null,
      "CoworkerInvoiceLineCoworkerInvoiceInvoiceNumber": null,
      "EventAttendeeId": null,
      "EventAttendeeCalendarEventName": null,
      "EventAttendeeEventProductName": null,
      "EventAttendeeFullName": null,
      "EventAttendeeEmail": null,
      "CreditUsed": 0,
      "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": "CoworkerBookingCreditUseHistory 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 CoworkerBookingCreditUseHistoryRetrieve a single CoworkerBookingCreditUseHistory record by its Id.

Search CoworkerBookingCreditUseHistories

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

import requests

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

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/coworkerbookingcreditusehistories', 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 CoworkerBookingCreditUseHistories

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