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

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

A **CoworkerDiscountCode** assigns a `DiscountCode` to a specific customer, allowing the system to track per-customer redemption history and enforce individual validity windows.

Use `ValidFrom` and `ExpiresOn` to set customer-specific validity dates. These are distinct from the discount code's own `ValidFrom`/`ValidTo` and `ExpirationType`/`ExpiresIn` fields — the system enforces whichever constraint is more restrictive.

When the discount is part of the referral programme, `RefererGuid` identifies the referring customer. `BookingUniqueId` links the assignment to the specific booking where the code was originally applied.

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

<ParamField query="CoworkerDiscountCode_Coworker_CoworkerType" type="string">
  Filter by whether the customer is an individual or a company.
</ParamField>

<ParamField query="CoworkerDiscountCode_Coworker_FullName" type="string">
  Filter by full name of the customer this discount code is assigned to.
</ParamField>

<ParamField query="CoworkerDiscountCode_Coworker_BillingName" type="string">
  Filter by billing name of the customer.
</ParamField>

<ParamField query="CoworkerDiscountCode_Coworker_CompanyName" type="string">
  Filter by company name of the customer.
</ParamField>

<ParamField query="CoworkerDiscountCode_Business" type="integer">
  Filter by iD of the location this assignment belongs to.
</ParamField>

<ParamField query="CoworkerDiscountCode_Business_Name" type="string">
  Filter by name of the location this assignment belongs to.
</ParamField>

<ParamField query="CoworkerDiscountCode_DiscountCode" type="integer">
  Filter by iD of the discount code assigned to this customer.
</ParamField>

<ParamField query="CoworkerDiscountCode_DiscountCode_Code" type="string">
  Filter by the alphanumeric code customers enter to apply the discount.
</ParamField>

<ParamField query="CoworkerDiscountCode_DiscountCode_Active" type="boolean">
  Filter by whether the discount code is currently active and can be redeemed.
</ParamField>

<ParamField query="CoworkerDiscountCode_DiscountCode_ValidFrom" type="string">
  Filter by start date from which the discount code itself can be redeemed (set on the discount code).
</ParamField>

<ParamField query="CoworkerDiscountCode_DiscountCode_ValidTo" type="string">
  Filter by end date after which the discount code itself can no longer be redeemed (set on the discount code).
</ParamField>

<ParamField query="CoworkerDiscountCode_Notes" type="string">
  Filter by optional notes about this discount code assignment.
</ParamField>

<ParamField query="CoworkerDiscountCode_TimesUsed" type="integer">
  Filter by number of times this customer has redeemed the discount code.
</ParamField>

<ParamField query="CoworkerDiscountCode_ValidFrom" type="string">
  Filter by customer-specific date from which this discount code assignment becomes valid.
</ParamField>

<ParamField query="CoworkerDiscountCode_ExpiresOn" type="string">
  Filter by customer-specific date after which this discount code assignment expires.
</ParamField>

<ParamField query="CoworkerDiscountCode_RefererGuid" type="string">
  Filter by unique identifier of the customer who referred this customer, when the discount is part of the referral programme.
</ParamField>

<ParamField query="CoworkerDiscountCode_BookingUniqueId" type="string">
  Filter by unique identifier of the booking to which this discount code was applied.
</ParamField>

### Range Filters

<ParamField query="from_CoworkerDiscountCode_DiscountCodeValidFrom" type="string">
  Filter by start date from which the discount code itself can be redeemed (set on the discount code) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerDiscountCode_DiscountCodeValidFrom" type="string">
  Filter by start date from which the discount code itself can be redeemed (set on the discount code) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerDiscountCode_DiscountCodeValidTo" type="string">
  Filter by end date after which the discount code itself can no longer be redeemed (set on the discount code) greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerDiscountCode_DiscountCodeValidTo" type="string">
  Filter by end date after which the discount code itself can no longer be redeemed (set on the discount code) less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerDiscountCode_TimesUsed" type="integer">
  Filter by number of times this customer has redeemed the discount code greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerDiscountCode_TimesUsed" type="integer">
  Filter by number of times this customer has redeemed the discount code less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerDiscountCode_ValidFrom" type="string">
  Filter by customer-specific date from which this discount code assignment becomes valid greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerDiscountCode_ValidFrom" type="string">
  Filter by customer-specific date from which this discount code assignment becomes valid less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="from_CoworkerDiscountCode_ExpiresOn" type="string">
  Filter by customer-specific date after which this discount code assignment expires greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerDiscountCode_ExpiresOn" type="string">
  Filter by customer-specific date after which this discount code assignment expires less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

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

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

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

<ParamField query="to_CoworkerDiscountCode_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/coworkerdiscountcodes?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/coworkerdiscountcodes?' + 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/coworkerdiscountcodes',
      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/coworkerdiscountcodes?CoworkerDiscountCode_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/coworkerdiscountcodes?' + new URLSearchParams({
      CoworkerDiscountCode_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/coworkerdiscountcodes',
      params={
          'CoworkerDiscountCode_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/coworkerdiscountcodes?from_CoworkerDiscountCode_UpdatedOn=2025-01-01T00:00&to_CoworkerDiscountCode_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/coworkerdiscountcodes?' + new URLSearchParams({
      from_CoworkerDiscountCode_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerDiscountCode_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/coworkerdiscountcodes',
      params={
          'from_CoworkerDiscountCode_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerDiscountCode_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="CoworkerDiscountCode[]">
  The list of CoworkerDiscountCode records matching the query. See the [Get one CoworkerDiscountCode](/rest-api/billing/get-coworkerdiscountcodes-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 CoworkerDiscountCode. The following fields are **not populated** in the `Records[]` response: `Notes`.

  To get all fields, fetch the full record using the [Get one CoworkerDiscountCode](/rest-api/billing/get-coworkerdiscountcodes-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,
      "CoworkerCoworkerType": null,
      "CoworkerFullName": null,
      "CoworkerBillingName": null,
      "CoworkerCompanyName": null,
      "BusinessId": 0,
      "BusinessName": null,
      "DiscountCodeId": 0,
      "DiscountCodeCode": null,
      "DiscountCodeActive": null,
      "DiscountCodeValidFrom": null,
      "DiscountCodeValidTo": null,
      "TimesUsed": 0,
      "ValidFrom": null,
      "ExpiresOn": null,
      "RefererGuid": null,
      "BookingUniqueId": 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": "CoworkerDiscountCode 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
}
```