> ## 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 CoworkerBookingCredits

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

A **CoworkerBookingCredit** is an amount of monetary credit assigned to a customer. Credits are typically created automatically when a customer's contract on a plan that includes a `TariffBookingCredit` renews, but can also be created manually.

Credit can be configured for two primary uses:

* **Bookings** — set `CaneBeUsedForBookings` to allow the credit to pay for bookings. Use `ElegibleResourceTypes` to restrict the credit to specific resource types; if left empty the credit is valid for all resource types.
* **Events** — set `CaneBeUsedForEvents` to allow the credit to pay for event sign-ups. Use `EventCategories` to restrict to specific event categories; if left empty the credit is valid for all events.

Setting `IsUniversalCredit` enables the credit for products, time passes, and other charges. Use `ElegibleProducts`, `ElegiblePasses`, and `AppliesToCharges` to restrict which products or passes the credit is valid for. If all restriction lists are empty the universal credit applies to all products, passes and charges.

Use `ValidFrom` and `ExpireDate` to control the validity window of the credit.

## 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 **`CoworkerBookingCredit-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="CoworkerBookingCredit_Coworker" type="integer">
  Filter by iD of the customer this credit is assigned to.
</ParamField>

<ParamField query="CoworkerBookingCredit_Business" type="integer">
  Filter by iD of the location issuing the credit.
</ParamField>

<ParamField query="CoworkerBookingCredit_Business_Name" type="string">
  Filter by location name.
</ParamField>

<ParamField query="CoworkerBookingCredit_Business_Currency_Code" type="string">
  Filter by currency code of the location.
</ParamField>

<ParamField query="CoworkerBookingCredit_Description" type="string">
  Filter by optional description or label for this credit.
</ParamField>

<ParamField query="CoworkerBookingCredit_TariffBookingCredit" type="integer">
  Filter by iD of the plan credit template (TariffBookingCredit) that originated this credit, if any.
</ParamField>

<ParamField query="CoworkerBookingCredit_TariffBookingCredit_Name" type="string">
  Filter by name of the plan credit template that originated this credit.
</ParamField>

<ParamField query="CoworkerBookingCredit_RemainingCredit" type="number">
  Filter by remaining credit balance.
</ParamField>

<ParamField query="CoworkerBookingCredit_TotalCredit" type="number">
  Filter by total credit amount originally assigned.
</ParamField>

<ParamField query="CoworkerBookingCredit_ValidFrom" type="string">
  Filter by date from which this credit is valid.
</ParamField>

<ParamField query="CoworkerBookingCredit_ExpireDate" type="string">
  Filter by date on which this credit expires.
</ParamField>

<ParamField query="CoworkerBookingCredit_CaneBeUsedForBookings" type="boolean">
  Filter by whether this credit can be used to pay for bookings. Restrict to specific resource types with `ElegibleResourceTypes`.
</ParamField>

<ParamField query="CoworkerBookingCredit_CaneBeUsedForEvents" type="boolean">
  Filter by whether this credit can be used to pay for event sign-ups. Restrict to specific categories with `EventCategories`.
</ParamField>

<ParamField query="CoworkerBookingCredit_IsUniversalCredit" type="boolean">
  Filter by whether this is a universal credit applicable to products, time passes and other charges. Restrict with `ElegibleProducts`, `ElegiblePasses` and `AppliesToCharges`; if all are empty the credit applies to all products, passes and charges.
</ParamField>

<ParamField query="CoworkerBookingCredit_CoworkerProductUniqueId" type="string">
  Filter by unique ID of the product purchase that created this credit.
</ParamField>

<ParamField query="CoworkerBookingCredit_UseCreditPrice" type="boolean">
  Filter by whether to use the credit price instead of the standard booking price when this credit is applied.
</ParamField>

<ParamField query="CoworkerBookingCredit_CoworkerContractUniqueId" type="string">
  Filter by unique ID of the contract that originated this credit.
</ParamField>

<ParamField query="CoworkerBookingCredit_AppliesToCharges" type="boolean">
  Filter by whether this universal credit applies to other charges.
</ParamField>

### Range Filters

<ParamField query="from_CoworkerBookingCredit_RemainingCredit" type="number">
  Filter by remaining credit balance greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerBookingCredit_RemainingCredit" type="number">
  Filter by remaining credit balance less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerBookingCredit_TotalCredit" type="number">
  Filter by total credit amount originally assigned greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerBookingCredit_TotalCredit" type="number">
  Filter by total credit amount originally assigned less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerBookingCredit_ValidFrom" type="string">
  Filter by date from which this credit is valid greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerBookingCredit_ValidFrom" type="string">
  Filter by date from which this credit is valid less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerBookingCredit_ExpireDate" type="string">
  Filter by date on which this credit expires greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerBookingCredit_ExpireDate" type="string">
  Filter by date on which this credit expires less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

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

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

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

<ParamField query="to_CoworkerBookingCredit_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/coworkerbookingcredits?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/coworkerbookingcredits?' + 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/coworkerbookingcredits',
      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/coworkerbookingcredits?CoworkerBookingCredit_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/coworkerbookingcredits?' + new URLSearchParams({
      CoworkerBookingCredit_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/coworkerbookingcredits',
      params={
          'CoworkerBookingCredit_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/coworkerbookingcredits?from_CoworkerBookingCredit_UpdatedOn=2025-01-01T00:00&to_CoworkerBookingCredit_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/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();
  ```

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

## Response

### 200

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

<Warning>
  **Partial records** — The listing endpoint returns a summary representation of each CoworkerBookingCredit. The following fields are **not populated** in the `Records[]` response: `Description`, `CaneBeUsedForBookings`, `CaneBeUsedForEvents`, `IsUniversalCredit`, `AppliesToCharges`.

  To get all fields, fetch the full record using the [Get one CoworkerBookingCredit](/rest-api/billing/get-coworkerbookingcredits-by-id) 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.
</Warning>

<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": [
    {
      "CoworkerId": 0,
      "BusinessId": 0,
      "BusinessName": null,
      "BusinessCurrencyCode": null,
      "TariffBookingCreditId": null,
      "TariffBookingCreditName": null,
      "ElegibleResourceTypes": [],
      "ElegibleProducts": [],
      "ElegibleTariffs": [],
      "RemainingCredit": 0,
      "TotalCredit": 0,
      "ValidFrom": null,
      "ExpireDate": null,
      "EventCategories": [],
      "CoworkerProductUniqueId": null,
      "UseCreditPrice": false,
      "CoworkerContractUniqueId": null,
      "ElegiblePasses": [],
      "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
}
```