Search CoworkerPricePlanHistories

GET

api

spaces

coworkerpriceplanhistories

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

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories"

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/spaces/coworkerpriceplanhistories', 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 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

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.

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

integer

Filter by iD of the coworker linked to this record.

string

Filter by name of the previous plan before the change.

string

Filter by name of the new plan after the change.

string

Filter by iD of the old tariff unique associated with this record.

string

Filter by iD of the new tariff unique associated with this record.

string

Filter by iD of the old contract unique associated with this record.

string

Filter by iD of the new contract unique associated with this record.

boolean

Filter by whether the plan change was an upgrade (new plan value is higher).

string

Filter by notes recorded at the time of the plan change.

number

Filter by price of the previous plan.

number

Filter by price of the new plan.

integer

Filter by quantity of the previous plan contract.

integer

Filter by quantity of the new plan contract.

string

Filter by date/time value for created on local.

Range Filters

number

Filter by price of the previous plan greater than or equal to this value.

number

Filter by price of the previous plan less than or equal to this value.

number

Filter by price of the new plan greater than or equal to this value.

number

Filter by price of the new plan less than or equal to this value.

integer

Filter by quantity of the previous plan contract greater than or equal to this value.

integer

Filter by quantity of the previous plan contract less than or equal to this value.

integer

Filter by quantity of the new plan contract greater than or equal to this value.

integer

Filter by quantity of the new plan contract less than or equal to this value.

string

Filter by date/time value for created on local greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

string

Filter by date/time value for created on local less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

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

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();

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()

Filtering by CreatedOn

curl -X GET \
  "https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories?CoworkerPricePlanHistory_CreatedOn=example-value&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

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();

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()

Range filters

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"

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();

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()

Response

200

CoworkerPricePlanHistory[]

The list of CoworkerPricePlanHistory records matching the query. See the Get one CoworkerPricePlanHistory endpoint for the full list of properties returned for each record.

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

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": [
    {
      "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
}

Get one CoworkerPricePlanHistoryRetrieve a single CoworkerPricePlanHistory record by its Id.

Search CoworkerPricePlanHistories

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

import requests

url = "https://spaces.nexudus.com/api/spaces/coworkerpriceplanhistories"

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/spaces/coworkerpriceplanhistories', 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 CoworkerPricePlanHistories

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