Search CrmOpportunityHistories

Search and list CrmOpportunityHistory records with filtering, sorting, and pagination.

GET /api/crm/crmopportunityhistories

Search CrmOpportunityHistories

cURL

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

200

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

A CrmOpportunityHistory records a single stage transition for a CRM opportunity. Each time an opportunity moves from one CRM stage to another, a history entry is created capturing the previous stage, the new stage, when the move happened, and which admin user triggered it.

Use this entity to audit the movement of opportunities across a CRM board over time. The History tab on an opportunity in the Nexudus UI displays these records.

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 CrmOpportunityHistory-List role.

Query Parameters

Pagination & Sorting

page · integer · default: "1"

The page number to retrieve.

size · integer · default: "25"

The number of records per page.

orderBy · string

The property name to sort results by (e.g. Name, CreatedOn).

dir · integer

Sort direction. 0 for ascending, 1 for descending.

Filters

CrmOpportunityHistory_CrmOpportunity · integer

Filter by the opportunity this history entry belongs to.

CrmOpportunityHistory_OldCrmBoardColumn · integer

Filter by cRM stage the opportunity moved from (null for the initial placement).

CrmOpportunityHistory_OldCrmBoardColumn_Name · string

Filter by name of the previous CRM stage.

CrmOpportunityHistory_FromTime · string

Filter by when the opportunity entered the previous stage.

CrmOpportunityHistory_ToTime · string

Filter by when the opportunity left the previous stage and entered the new one.

CrmOpportunityHistory_NewCrmBoardColumn · integer

Filter by cRM stage the opportunity moved to.

CrmOpportunityHistory_NewCrmBoardColumn_Name · string

Filter by name of the new CRM stage.

CrmOpportunityHistory_User · integer

Filter by admin user who triggered the stage transition (null if moved automatically).

CrmOpportunityHistory_User_FullName · string

Filter by full name of the admin user who triggered the transition.

Range Filters

from_CrmOpportunityHistory_FromTime · string

Filter by when the opportunity entered the previous stage greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunityHistory_FromTime · string

Filter by when the opportunity entered the previous stage less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunityHistory_ToTime · string

Filter by when the opportunity left the previous stage and entered the new one greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunityHistory_ToTime · string

Filter by when the opportunity left the previous stage and entered the new one less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunityHistory_CreatedOn · string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunityHistory_CreatedOn · string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunityHistory_UpdatedOn · string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunityHistory_UpdatedOn · string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/crm/crmopportunityhistories?page=1&size=15&orderBy=CreatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Filtering by CreatedOn

cURL

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

Range filters

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/crm/crmopportunityhistories?from_CrmOpportunityHistory_UpdatedOn=2025-01-01T00:00&to_CrmOpportunityHistory_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Records · CrmOpportunityHistory[]

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

Partial records — The listing endpoint returns a summary representation of each CrmOpportunityHistory. The following fields are not populated in the Records[] response: FromTime, ToTime.

To get all fields, fetch the full record using the Get one CrmOpportunityHistory 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.

CurrentPage · integer

Current page number.

CurrentPageSize · integer

Number of records per page.

CurrentOrderField · string

The field used for sorting.

CurrentSortDirection · integer

The sort direction (0 = ascending, 1 = descending).

FirstItem · integer

Index of the first item on the current page.

LastItem · integer

Index of the last item on the current page.

TotalItems · integer

Total number of matching records across all pages.

TotalPages · integer

Total number of pages.

HasNextPage · boolean

Whether there is a next page of results.

HasPreviousPage · boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "CrmOpportunityId": null,
      "OldCrmBoardColumnId": null,
      "OldCrmBoardColumnName": null,
      "NewCrmBoardColumnId": 0,
      "NewCrmBoardColumnName": null,
      "UserId": null,
      "UserFullName": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "[e-mail]",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "CrmOpportunityHistory 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
}