Get one CrmOpportunity

Retrieve a single CrmOpportunity record by its Id.

GET /api/crm/crmopportunities/{id}

Get one CrmOpportunity

cURL

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

200

{
  "Name": "<string>",
  "CrmBoardColumnId": 123,
  "CrmBoardColumnName": "<string>",
  "CrmBoardColumnCrmBoardId": 123,
  "CrmBoardColumnCrmBoardName": "<string>",
  "CrmBoardColumnCrmBoardBusinessId": 123,
  "CrmBoardColumnCrmBoardBusinessName": "<string>",
  "CrmBoardColumnCrmBoardBusinessCurrencyId": 123,
  "CrmBoardColumnCrmBoardBusinessCurrencyCode": "<string>",
  "CoworkerId": 123,
  "CoworkerFullName": "<string>",
  "CoworkerCoworkerType": "<string>",
  "CoworkerCompanyName": "<string>",
  "CoworkerEmail": "<string>",
  "TeamId": 123,
  "TeamName": "<string>",
  "TeamDescription": "<string>",
  "TeamProfileWebsite": "<string>",
  "OpportunityTypeId": 123,
  "OpportunityTypeName": "<string>",
  "ResponsibleId": 123,
  "ResponsibleFullName": "<string>",
  "ReferrerId": 123,
  "AgentId": 123,
  "Notes": "<string>",
  "Completed": true,
  "DueDate": "<string>",
  "Value": 123,
  "Reminded": true,
  "LeadSource": 123,
  "LossReason": 123,
  "Status": 123,
  "WonOn": "<string>",
  "LostOn": "<string>",
  "CrmUpdatedOn": "<string>",
  "Position": 123,
  "UtmSource": "<string>",
  "UtmMedium": "<string>",
  "UtmCampaign": "<string>",
  "UtmContent": "<string>",
  "UtmTerm": "<string>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

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

Path Parameters

id · integer · required

The Id of the CrmOpportunity record to retrieve.

Code Examples

cURL

curl -X GET \
  "https://spaces.nexudus.com/api/crm/crmopportunities/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

Response

200

Name · string

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

CrmBoardColumnId · integer

Crm Board Column Id.

CrmBoardColumnName · string

CRM stage name.

CrmBoardColumnCrmBoardId · integer

CRM board ID.

CrmBoardColumnCrmBoardName · string

CRM board name.

CrmBoardColumnCrmBoardBusinessId · integer

Business ID of the CRM board.

CrmBoardColumnCrmBoardBusinessName · string

Business name of the CRM board.

CrmBoardColumnCrmBoardBusinessCurrencyId · integer

Currency ID of the CRM board’s business.

CrmBoardColumnCrmBoardBusinessCurrencyCode · string

Currency code of the CRM board’s business.

CoworkerId · integer

Coworker Id.

CoworkerFullName · string

Customer full name.

CoworkerCoworkerType · string

Customer record type.

CoworkerCompanyName · string

Customer company name.

CoworkerEmail · string

Customer email address.

TeamId · integer

Team Id.

TeamName · string

Team name.

TeamDescription · string

Team description.

TeamProfileWebsite · string

Team profile website.

OpportunityTypeId · integer

Opportunity type used to categorise and auto-populate general notes from a template.

OpportunityTypeName · string

Opportunity type name.

ResponsibleId · integer

Admin user responsible for managing this opportunity.

ResponsibleFullName · string

Responsible admin full name.

ReferrerId · integer

Customer who referred this opportunity.

AgentId · integer

External agent or broker who brought this opportunity.

Notes · string

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

Completed · boolean

Whether the opportunity has been completed (won or lost).

DueDate · string

Follow-up date for the opportunity.

Value · number

Expected revenue if the opportunity is won.

Reminded · boolean

Whether a follow-up reminder has been sent for this opportunity.

LeadSource · integer

How the opportunity was acquired (e.g. Web, Phone, Referral, Broker, GoogleSearch).

LossReason · integer

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

Status · integer

Opportunity status: InProgress (still active), Won (led to a sale), or Lost (did not lead to a sale). See eCrmOpportunityStatus enum values: 1 = InProgress, 2 = Won, 3 = Lost.

WonOn · string

Date when the opportunity was marked as won.

LostOn · string

Date when the opportunity was marked as lost.

CrmUpdatedOn · string

Timestamp of the last CRM-related update to this opportunity.

Position · integer

Display order of the opportunity within its current stage.

UtmSource · string

UTM source parameter captured from the URL the opportunity used.

UtmMedium · string

UTM medium parameter captured from the URL the opportunity used.

UtmCampaign · string

UTM campaign parameter captured from the URL the opportunity used.

UtmContent · string

UTM content parameter captured from the URL the opportunity used.

UtmTerm · string

UTM term parameter captured from the URL the opportunity used.

Id · integer

Unique record identifier.

UniqueId · string

UUID of the record.

CreatedOn · string

Date and time the record was created (ISO 8601).

UpdatedOn · string

Date and time the record was last updated (ISO 8601).

UpdatedBy · string

Email of the user who last updated this record.

IsNew · boolean

Whether the record was recently created.

SystemId · string

External system identifier.

Example Response

{
  "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": "[e-mail]",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CrmOpportunity Example",
  "LocalizationDetails": null,
  "CustomFields": null
}