Search CrmOpportunities - Nexudus Platform

GET

api

crm

crmopportunities

Search CrmOpportunities

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

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

A CrmOpportunity represents a potential or existing deal linked to a customer record that moves through stages on a CRM board. Opportunities track the lifecycle of a customer interaction — from initial enquiry or tour request through to a won or lost outcome. Each opportunity sits in a single CRM stage (CrmBoardColumn) and can be moved between stages manually or automatically via stage auto-assignment rules. Key fields:

Status — InProgress, Won, or Lost. Stages with WinOpportunity or LoseOpportunity update this automatically.
LeadSource — how the opportunity was acquired (e.g. Web, Phone, Referral, Broker, GoogleSearch).
LossReason — why the opportunity was lost (e.g. Price, Competition, Location). Only meaningful when Status is Lost.
Value — expected revenue if the opportunity is won.
DueDate — follow-up date for the opportunity.
UTM fields — automatically populated from the URL the opportunity used to reach the sign-up or contact form.

There is a limit of 5,000 opportunities per location.

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.

Enums

eCrmOpportunitySource

Value	Name
1	Web
2	Phone
4	Webinar
5	Referral
6	PrintAdvert
7	PurchasedList
8	WordOfMouth
9	DirectEmail
10	EmailMarketing
11	Broker
12	PropertyAgent
13	Facebook
14	Linkedin
15	Instagram
16	Twitter
17	HubbleHq
18	LiquidSpace
19	GoogleSearch
20	SpacePool
21	InstantOffices
22	OfficeFreedom
23	FlexiOffices
24	Workthere
25	Kontor
26	Valve
98	OtherSocialNetwork
99	Other

eCrmOpportunityLossReason

Value	Name
1	Timing
2	Need
3	PoorQualification
4	Price
5	Feature
6	LostMomentum
7	Competition
8	ContractTerm
9	Duplicate
10	Waitlist
11	NotReturningCalls
12	LackOfFacilities
13	NoPetPolicy
14	NoRightFit
15	Location
16	Entrance
17	Errors
18	Archived
19	SearchOnHold
20	RelocationOnHold
99	Other

eCrmOpportunityStatus — Status values

Value	Name
1	InProgress
2	Won
3	Lost

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

CrmOpportunity_Name

string

Filter by optional tag to identify this opportunity, useful when the same customer appears in multiple boards.

CrmOpportunity_CrmBoardColumn

integer

Filter by Crm Board Column Id.

CrmOpportunity_CrmBoardColumn_Name

string

Filter by cRM stage name.

CrmOpportunity_CrmBoardColumn_CrmBoard_Id

integer

Filter by cRM board ID.

CrmOpportunity_CrmBoardColumn_CrmBoard_Name

string

Filter by cRM board name.

CrmOpportunity_CrmBoardColumn_CrmBoard_Business_Id

integer

Filter by business ID of the CRM board.

CrmOpportunity_CrmBoardColumn_CrmBoard_Business_Name

string

Filter by business name of the CRM board.

CrmOpportunity_CrmBoardColumn_CrmBoard_Business_Currency_Id

integer

Filter by currency ID of the CRM board’s business.

CrmOpportunity_CrmBoardColumn_CrmBoard_Business_Currency_Code

string

Filter by currency code of the CRM board’s business.

CrmOpportunity_Coworker

integer

Filter by Coworker Id.

CrmOpportunity_Coworker_FullName

string

Filter by customer full name.

CrmOpportunity_Coworker_CoworkerType

string

Filter by customer record type.

CrmOpportunity_Coworker_CompanyName

string

Filter by customer company name.

CrmOpportunity_Coworker_Email

string

Filter by customer email address.

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 used to categorise and auto-populate general notes from a template.

CrmOpportunity_OpportunityType_Name

string

Filter by opportunity type name.

CrmOpportunity_Responsible

integer

Filter by admin user responsible for managing this opportunity.

CrmOpportunity_Responsible_FullName

string

Filter by responsible admin full name.

CrmOpportunity_Referrer

integer

Filter by customer who referred this opportunity.

CrmOpportunity_Agent

integer

Filter by external agent or broker who brought this opportunity.

CrmOpportunity_Notes

string

Filter by general notes visible to admins when viewing the opportunity. Auto-populated from the opportunity type template if a type is assigned.

CrmOpportunity_Completed

boolean

Filter by whether the opportunity has been completed (won or lost).

CrmOpportunity_DueDate

string

Filter by follow-up date for the opportunity.

CrmOpportunity_Value

number

Filter by expected revenue if the opportunity is won.

CrmOpportunity_Reminded

boolean

Filter by whether a follow-up reminder has been sent for this opportunity.

CrmOpportunity_LeadSource

integer

Filter by how the opportunity was acquired (e.g. Web, Phone, Referral, Broker, GoogleSearch).

CrmOpportunity_LossReason

integer

Filter by why the opportunity was lost (e.g. Price, Competition, Location). Only relevant when Status is Lost.

CrmOpportunity_Status

integer

Filter by opportunity status: InProgress (still active), Won (led to a sale), or Lost (did not lead to a sale).

CrmOpportunity_WonOn

string

Filter by date when the opportunity was marked as won.

CrmOpportunity_LostOn

string

Filter by date when the opportunity was marked as lost.

CrmOpportunity_CrmUpdatedOn

string

Filter by timestamp of the last CRM-related update to this opportunity.

CrmOpportunity_Position

integer

Filter by display order of the opportunity within its current stage.

CrmOpportunity_UtmSource

string

Filter by uTM source parameter captured from the URL the opportunity used.

CrmOpportunity_UtmMedium

string

Filter by uTM medium parameter captured from the URL the opportunity used.

CrmOpportunity_UtmCampaign

string

Filter by uTM campaign parameter captured from the URL the opportunity used.

CrmOpportunity_UtmContent

string

Filter by uTM content parameter captured from the URL the opportunity used.

CrmOpportunity_UtmTerm

string

Filter by uTM term parameter captured from the URL the opportunity used.

Range Filters

from_CrmOpportunity_CrmBoardColumnCrmBoardId

integer

Filter by cRM board ID greater than or equal to this value.

to_CrmOpportunity_CrmBoardColumnCrmBoardId

integer

Filter by cRM board ID less than or equal to this value.

from_CrmOpportunity_CrmBoardColumnCrmBoardBusinessId

integer

Filter by business ID of the CRM board greater than or equal to this value.

to_CrmOpportunity_CrmBoardColumnCrmBoardBusinessId

integer

Filter by business ID of the CRM board less than or equal to this value.

from_CrmOpportunity_CrmBoardColumnCrmBoardBusinessCurrencyId

integer

Filter by currency ID of the CRM board’s business greater than or equal to this value.

to_CrmOpportunity_CrmBoardColumnCrmBoardBusinessCurrencyId

integer

Filter by currency ID of the CRM board’s business less than or equal to this value.

from_CrmOpportunity_DueDate

string

Filter by follow-up date for the opportunity greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunity_DueDate

string

Filter by follow-up date for the opportunity less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunity_Value

number

Filter by expected revenue if the opportunity is won greater than or equal to this value.

to_CrmOpportunity_Value

number

Filter by expected revenue if the opportunity is won less than or equal to this value.

from_CrmOpportunity_WonOn

string

Filter by date when the opportunity was marked as won greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunity_WonOn

string

Filter by date when the opportunity was marked as won less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunity_LostOn

string

Filter by date when the opportunity was marked as lost greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunity_LostOn

string

Filter by date when the opportunity was marked as lost less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunity_CrmUpdatedOn

string

Filter by timestamp of the last CRM-related update to this opportunity greater than or equal to this value. Format: YYYY-MM-DDTHH:mm.

to_CrmOpportunity_CrmUpdatedOn

string

Filter by timestamp of the last CRM-related update to this opportunity less than or equal to this value. Format: YYYY-MM-DDTHH:mm.

from_CrmOpportunity_Position

integer

Filter by display order of the opportunity within its current stage greater than or equal to this value.

to_CrmOpportunity_Position

integer

Filter by display order of the opportunity within its current stage 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=0" \
  -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=0" \
  -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=0" \
  -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 populated 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 (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": [
    {
      "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,
      "TeamName": null,
      "TeamDescription": null,
      "TeamProfileWebsite": null,
      "OpportunityTypeId": null,
      "OpportunityTypeName": null,
      "ResponsibleId": null,
      "ResponsibleFullName": null,
      "ReferrerId": null,
      "AgentId": null,
      "Completed": false,
      "DueDate": null,
      "Status": 0,
      "WonOn": null,
      "LostOn": null,
      "CrmUpdatedOn": 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
}

Get one CrmOpportunityRetrieve a single CrmOpportunity record by its Id.

Search CrmOpportunities

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

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

Documentation Index

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by CreatedOn

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by CreatedOn

Range filters

Response

200