> ## Documentation Index
> Fetch the complete documentation index at: https://learn.nexudus.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Search CoworkerBookingCreditUseHistories

> Search and list CoworkerBookingCreditUseHistory records with filtering, sorting, and pagination.

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

<Note>
  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.
</Note>

## Query Parameters

### Pagination & Sorting

<ParamField query="page" type="integer" default="1">
  The page number to retrieve.
</ParamField>

<ParamField query="size" type="integer" default="25">
  The number of records per page.
</ParamField>

<ParamField query="orderBy" type="string">
  The property name to sort results by (e.g. `Name`, `CreatedOn`).
</ParamField>

<ParamField query="dir" type="integer">
  Sort direction. `0` for ascending, `1` for descending.
</ParamField>

### Filters

<ParamField query="CoworkerBookingCreditUseHistory_Description" type="string">
  Filter by optional description or note for this credit use entry.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_CoworkerBookingCredit" type="integer">
  Filter by iD of the booking credit that was consumed.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_Booking" type="integer">
  Filter by iD of the booking this credit was applied to, if the credit was used for a booking.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_Booking_FromTime" type="string">
  Filter by start time of the booking.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_Booking_ToTime" type="string">
  Filter by end time of the booking.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_Booking_Resource_Name" type="string">
  Filter by name of the resource that was booked.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_CoworkerInvoiceLine" type="integer">
  Filter by iD of the invoice line this credit was applied to, if the credit was used against an invoice.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_CoworkerInvoiceLine_CoworkerInvoice_Id" type="integer">
  Filter by iD of the invoice containing the linked invoice line.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_CoworkerInvoiceLine_CoworkerInvoice_InvoiceNumber" type="string">
  Filter by invoice number of the invoice containing the linked invoice line.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_EventAttendee" type="integer">
  Filter by iD of the event attendance record this credit was applied to, if the credit was used for an event.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_EventAttendee_CalendarEvent_Name" type="string">
  Filter by name of the calendar event the credit was used for.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_EventAttendee_EventProduct_Name" type="string">
  Filter by name of the event ticket product purchased by the attendee.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_EventAttendee_FullName" type="string">
  Filter by full name of the event attendee.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_EventAttendee_Email" type="string">
  Filter by email address of the event attendee.
</ParamField>

<ParamField query="CoworkerBookingCreditUseHistory_CreditUsed" type="number">
  Filter by amount of credit consumed by this entry.
</ParamField>

### Range Filters

<ParamField query="from_CoworkerBookingCreditUseHistory_BookingFromTime" type="string">
  Filter by start time of the booking greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerBookingCreditUseHistory_BookingFromTime" type="string">
  Filter by start time of the booking less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerBookingCreditUseHistory_BookingToTime" type="string">
  Filter by end time of the booking greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerBookingCreditUseHistory_BookingToTime" type="string">
  Filter by end time of the booking less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerBookingCreditUseHistory_CoworkerInvoiceLineCoworkerInvoiceId" type="integer">
  Filter by iD of the invoice containing the linked invoice line greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerBookingCreditUseHistory_CoworkerInvoiceLineCoworkerInvoiceId" type="integer">
  Filter by iD of the invoice containing the linked invoice line less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerBookingCreditUseHistory_CreditUsed" type="number">
  Filter by amount of credit consumed by this entry greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerBookingCreditUseHistory_CreditUsed" type="number">
  Filter by amount of credit consumed by this entry less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerBookingCreditUseHistory_CreatedOn" type="string">
  Filter records created on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerBookingCreditUseHistory_CreatedOn" type="string">
  Filter records created on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerBookingCreditUseHistory_UpdatedOn" type="string">
  Filter records updated on or after this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerBookingCreditUseHistory_UpdatedOn" type="string">
  Filter records updated on or before this date. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

## Code Examples

### Simple listing

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories?page=1&size=15&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Filtering by CreatedOn

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET \
    "https://spaces.nexudus.com/api/billing/coworkerbookingcreditusehistories?CoworkerBookingCreditUseHistory_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
    -H "Authorization: Bearer YOUR_TOKEN"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

### Range filters

<CodeGroup>
  ```bash cURL theme={null}
  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"
  ```

  ```javascript JavaScript theme={null}
  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();
  ```

  ```python Python theme={null}
  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()
  ```
</CodeGroup>

## Response

### 200

<ResponseField name="Records" type="CoworkerBookingCreditUseHistory[]">
  The list of CoworkerBookingCreditUseHistory records matching the query. See the [Get one CoworkerBookingCreditUseHistory](/rest-api/billing/get-coworkerbookingcreditusehistories-by-id) endpoint for the full list of properties returned for each record.
</ResponseField>

<ResponseField name="CurrentPage" type="integer">
  Current page number.
</ResponseField>

<ResponseField name="CurrentPageSize" type="integer">
  Number of records per page.
</ResponseField>

<ResponseField name="CurrentOrderField" type="string">
  The field used for sorting.
</ResponseField>

<ResponseField name="CurrentSortDirection" type="integer">
  The sort direction (`0` = ascending, `1` = descending).
</ResponseField>

<ResponseField name="FirstItem" type="integer">
  Index of the first item on the current page.
</ResponseField>

<ResponseField name="LastItem" type="integer">
  Index of the last item on the current page.
</ResponseField>

<ResponseField name="TotalItems" type="integer">
  Total number of matching records across all pages.
</ResponseField>

<ResponseField name="TotalPages" type="integer">
  Total number of pages.
</ResponseField>

<ResponseField name="HasNextPage" type="boolean">
  Whether there is a next page of results.
</ResponseField>

<ResponseField name="HasPreviousPage" type="boolean">
  Whether there is a previous page of results.
</ResponseField>

```json Example Response theme={null}
{
  "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
}
```