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

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

A **CoworkerPricePlanHistory** is an audit record of the different contracts (for different plans - Tariff entity) a customer has had. Each entry captures a plan change — recording the previous and new plan names, their values, and whether the change was an upgrade.

This entity is read-only and is created automatically by the system whenever a customer's plan changes.

## 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 **`CoworkerPricePlanHistory-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="CoworkerPricePlanHistory_Coworker" type="integer">
  Filter by Coworker Id.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_OldTariffName" type="string">
  Filter by name of the previous plan before the change.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_NewTariffName" type="string">
  Filter by name of the new plan after the change.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_OldTariffUniqueId" type="string">
  Filter by Old Tariff Unique Id.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_NewTariffUniqueId" type="string">
  Filter by New Tariff Unique Id.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_OldContractUniqueId" type="string">
  Filter by Old Contract Unique Id.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_NewContractUniqueId" type="string">
  Filter by New Contract Unique Id.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_IsUpgrade" type="boolean">
  Filter by whether the plan change was an upgrade (new plan value is higher).
</ParamField>

<ParamField query="CoworkerPricePlanHistory_Notes" type="string">
  Filter by notes recorded at the time of the plan change.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_OldValue" type="number">
  Filter by price of the previous plan.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_NewValue" type="number">
  Filter by price of the new plan.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_OldQuantity" type="integer">
  Filter by quantity of the previous plan contract.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_NewQuantity" type="integer">
  Filter by quantity of the new plan contract.
</ParamField>

<ParamField query="CoworkerPricePlanHistory_CreatedOnLocal" type="string">
  Filter by Created On Local.
</ParamField>

### Range Filters

<ParamField query="from_CoworkerPricePlanHistory_OldValue" type="number">
  Filter by price of the previous plan greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerPricePlanHistory_OldValue" type="number">
  Filter by price of the previous plan less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerPricePlanHistory_NewValue" type="number">
  Filter by price of the new plan greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerPricePlanHistory_NewValue" type="number">
  Filter by price of the new plan less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerPricePlanHistory_OldQuantity" type="integer">
  Filter by quantity of the previous plan contract greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerPricePlanHistory_OldQuantity" type="integer">
  Filter by quantity of the previous plan contract less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerPricePlanHistory_NewQuantity" type="integer">
  Filter by quantity of the new plan contract greater than or equal to this value.
</ParamField>

<ParamField query="to_CoworkerPricePlanHistory_NewQuantity" type="integer">
  Filter by quantity of the new plan contract less than or equal to this value.
</ParamField>

<ParamField query="from_CoworkerPricePlanHistory_CreatedOnLocal" type="string">
  Filter by created on local greater than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

<ParamField query="to_CoworkerPricePlanHistory_CreatedOnLocal" type="string">
  Filter by created on local less than or equal to this value. Format: `YYYY-MM-DDTHH:mm`.
</ParamField>

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

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

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

<ParamField query="to_CoworkerPricePlanHistory_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/spaces/coworkerpriceplanhistories?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/spaces/coworkerpriceplanhistories?' + 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/spaces/coworkerpriceplanhistories',
      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/spaces/coworkerpriceplanhistories?CoworkerPricePlanHistory_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/spaces/coworkerpriceplanhistories?' + new URLSearchParams({
      CoworkerPricePlanHistory_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/spaces/coworkerpriceplanhistories',
      params={
          'CoworkerPricePlanHistory_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/spaces/coworkerpriceplanhistories?from_CoworkerPricePlanHistory_UpdatedOn=2025-01-01T00:00&to_CoworkerPricePlanHistory_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/spaces/coworkerpriceplanhistories?' + new URLSearchParams({
      from_CoworkerPricePlanHistory_UpdatedOn: '2025-01-01T00:00',
      to_CoworkerPricePlanHistory_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/spaces/coworkerpriceplanhistories',
      params={
          'from_CoworkerPricePlanHistory_UpdatedOn': '2025-01-01T00:00',
          'to_CoworkerPricePlanHistory_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="CoworkerPricePlanHistory[]">
  The list of CoworkerPricePlanHistory records matching the query. See the [Get one CoworkerPricePlanHistory](/rest-api/spaces/get-coworkerpriceplanhistories-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 CoworkerPricePlanHistory. The following fields are **not populated** in the `Records[]` response: `Notes`, `OldValue`, `NewValue`, `OldQuantity`, `NewQuantity`.

  To get all fields, fetch the full record using the [Get one CoworkerPricePlanHistory](/rest-api/spaces/get-coworkerpriceplanhistories-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,
      "OldTariffName": null,
      "NewTariffName": null,
      "OldTariffUniqueId": null,
      "NewTariffUniqueId": null,
      "OldContractUniqueId": null,
      "NewContractUniqueId": null,
      "IsUpgrade": false,
      "CreatedOnLocal": 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": "CoworkerPricePlanHistory 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
}
```