Search CrmOpportunities

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 CrmOpportunity-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. 1 for ascending, -1 for descending.

Filters

CrmOpportunity_Name

string

Filter by Name.

CrmOpportunity_CrmBoardColumn

integer

Filter by Crm Board Column Id.

CrmOpportunity_CrmBoardColumn_Name

string

Filter by Crm Board Column Name.

CrmOpportunity_CrmBoardColumn_CrmBoard_Id

integer

Filter by Crm Board Column Crm Board Id.

CrmOpportunity_CrmBoardColumn_CrmBoard_Name

string

Filter by Crm Board Column Crm Board Name.

CrmOpportunity_CrmBoardColumn_CrmBoard_Business_Id

integer

Filter by Crm Board Column Crm Board Business Id.

CrmOpportunity_CrmBoardColumn_CrmBoard_Business_Name

string

Filter by Crm Board Column Crm Board Business Name.

CrmOpportunity_CrmBoardColumn_CrmBoard_Business_Currency_Id

integer

Filter by Crm Board Column Crm Board Business Currency Id.

CrmOpportunity_CrmBoardColumn_CrmBoard_Business_Currency_Code

string

Filter by Crm Board Column Crm Board Business Currency Code.

CrmOpportunity_Coworker

integer

Filter by Coworker Id.

CrmOpportunity_Coworker_FullName

string

Filter by Coworker Full Name.

CrmOpportunity_Coworker_CoworkerType

string

Filter by Coworker Coworker Type.

CrmOpportunity_Coworker_CompanyName

string

Filter by Coworker Company Name.

CrmOpportunity_Coworker_Email

string

Filter by Coworker Email.

CrmOpportunity_Team

integer

Filter by Team Id.

CrmOpportunity_Team_Name

string

Filter by Team Name.

CrmOpportunity_Team_Description

string

Filter by Team Description.

CrmOpportunity_Team_ProfileWebsite

string

Filter by Team Profile Website.

CrmOpportunity_OpportunityType

integer

Filter by Opportunity Type Id.

CrmOpportunity_OpportunityType_Name

string

Filter by Opportunity Type Name.

CrmOpportunity_Responsible

integer

Filter by Responsible Id.

CrmOpportunity_Responsible_FullName

string

Filter by Responsible Full Name.

CrmOpportunity_Referrer

integer

Filter by Referrer Id.

CrmOpportunity_Agent

integer

Filter by Agent Id.

CrmOpportunity_Notes

string

Filter by Notes.

CrmOpportunity_Completed

boolean

Filter by Completed.

CrmOpportunity_DueDate

string

Filter by Due Date.

CrmOpportunity_Value

number

Filter by Value.

CrmOpportunity_Reminded

boolean

Filter by Reminded.

CrmOpportunity_LeadSource

integer

Filter by Lead Source.

CrmOpportunity_LossReason

integer

Filter by Loss Reason.

CrmOpportunity_Status

integer

Filter by Status.

CrmOpportunity_WonOn

string

Filter by Won On.

CrmOpportunity_LostOn

string

Filter by Lost On.

CrmOpportunity_CrmUpdatedOn

string

Filter by Crm Updated On.

CrmOpportunity_Position

integer

Filter by Position.

CrmOpportunity_UtmSource

string

Filter by Utm Source.

CrmOpportunity_UtmMedium

string

Filter by Utm Medium.

CrmOpportunity_UtmCampaign

string

Filter by Utm Campaign.

CrmOpportunity_UtmContent

string

Filter by Utm Content.

CrmOpportunity_UtmTerm

string

Filter by Utm Term.

Range Filters

from_CrmOpportunity_CrmBoardColumnCrmBoardId

integer

Filter by crm board column crm board id greater than or equal to this value.

to_CrmOpportunity_CrmBoardColumnCrmBoardId

integer

Filter by crm board column crm board id less than or equal to this value.

from_CrmOpportunity_CrmBoardColumnCrmBoardBusinessId

integer

Filter by crm board column crm board business id greater than or equal to this value.

to_CrmOpportunity_CrmBoardColumnCrmBoardBusinessId

integer

Filter by crm board column crm board business id less than or equal to this value.

from_CrmOpportunity_CrmBoardColumnCrmBoardBusinessCurrencyId

integer

Filter by crm board column crm board business currency id greater than or equal to this value.

to_CrmOpportunity_CrmBoardColumnCrmBoardBusinessCurrencyId

integer

Filter by crm board column crm board business currency id less than or equal to this value.

from_CrmOpportunity_DueDate

string

Filter by due date greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunity_DueDate

string

Filter by due date less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunity_Value

number

Filter by value greater than or equal to this value.

to_CrmOpportunity_Value

number

Filter by value less than or equal to this value.

from_CrmOpportunity_WonOn

string

Filter by won on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunity_WonOn

string

Filter by won on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunity_LostOn

string

Filter by lost on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunity_LostOn

string

Filter by lost on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunity_CrmUpdatedOn

string

Filter by crm updated on greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunity_CrmUpdatedOn

string

Filter by crm updated on less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunity_Position

integer

Filter by position greater than or equal to this value.

to_CrmOpportunity_Position

integer

Filter by position less than or equal to this value.

from_CrmOpportunity_CreatedOn

string

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

to_CrmOpportunity_CreatedOn

string

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

from_CrmOpportunity_UpdatedOn

string

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

to_CrmOpportunity_UpdatedOn

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

Filtering by CreatedOn

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

Range filters

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

Response

200

Records

CrmOpportunity[]

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

Partial records — The listing endpoint returns a summary representation of each CrmOpportunity. The following fields are not included in the Records[] response: TeamId, Notes, Value, Reminded, LeadSource, LossReason, Position, UtmSource, UtmMedium, UtmCampaign, UtmContent, UtmTerm.To get all fields, fetch the full record using the Get one CrmOpportunity 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 (1 = 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": [
    {
      "Name": null,
      "CrmBoardColumnId": 0,
      "CrmBoardColumnName": null,
      "CrmBoardColumnCrmBoardId": null,
      "CrmBoardColumnCrmBoardName": null,
      "CrmBoardColumnCrmBoardBusinessId": null,
      "CrmBoardColumnCrmBoardBusinessName": null,
      "CrmBoardColumnCrmBoardBusinessCurrencyId": null,
      "CrmBoardColumnCrmBoardBusinessCurrencyCode": null,
      "CoworkerId": null,
      "CoworkerFullName": null,
      "CoworkerCoworkerType": null,
      "CoworkerCompanyName": null,
      "CoworkerEmail": null,
      "TeamId": null,
      "TeamName": null,
      "TeamDescription": null,
      "TeamProfileWebsite": null,
      "OpportunityTypeId": null,
      "OpportunityTypeName": null,
      "ResponsibleId": null,
      "ResponsibleFullName": null,
      "ReferrerId": null,
      "AgentId": null,
      "Notes": null,
      "Completed": false,
      "DueDate": null,
      "Value": null,
      "Reminded": false,
      "LeadSource": 0,
      "LossReason": 0,
      "Status": 0,
      "WonOn": null,
      "LostOn": null,
      "CrmUpdatedOn": null,
      "Position": 0,
      "UtmSource": null,
      "UtmMedium": null,
      "UtmCampaign": null,
      "UtmContent": null,
      "UtmTerm": 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": "CrmOpportunity 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
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

​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