Get one CrmOpportunity

GET

api

crm

crmopportunities

{id}

Get one CrmOpportunity

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

import requests

url = "https://spaces.nexudus.com/api/crm/crmopportunities/{id}"

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/crm/crmopportunities/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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

integer

required

The Id of the CrmOpportunity record to retrieve.

Code Examples

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

const response = await fetch(
  'https://spaces.nexudus.com/api/crm/crmopportunities/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/crm/crmopportunities/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

string

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

integer

ID of the crm board column linked to this record.

string

CRM stage name.

integer

CRM board ID.

string

CRM board name.

integer

Business ID of the CRM board.

string

Business name of the CRM board.

integer

Currency ID of the CRM board’s business.

string

Currency code of the CRM board’s business.

integer

ID of the coworker linked to this record.

string

Customer full name.

string

Customer record type.

string

Customer company name.

string

Customer email address.

integer

ID of the team linked to this record.

string

Team name.

string

Team description.

string

Team profile website.

integer

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

string

Opportunity type name.

integer

Admin user responsible for managing this opportunity.

string

Responsible admin full name.

integer

Customer who referred this opportunity.

integer

External agent or broker who brought this opportunity.

string

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

boolean

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

string

Follow-up date for the opportunity.

number

Expected revenue if the opportunity is won.

boolean

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

integer

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

integer

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

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.

string

Date when the opportunity was marked as won.

string

Date when the opportunity was marked as lost.

string

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

integer

Display order of the opportunity within its current stage.

string

UTM source parameter captured from the URL the opportunity used.

string

UTM medium parameter captured from the URL the opportunity used.

string

UTM campaign parameter captured from the URL the opportunity used.

string

UTM content parameter captured from the URL the opportunity used.

string

UTM term parameter captured from the URL the opportunity used.

integer

Unique record identifier.

string

UUID of the record.

string

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

string

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

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

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": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CrmOpportunity Example",
  "LocalizationDetails": null,
  "CustomFields": null
}

Get multiple CrmOpportunitiesRetrieve multiple CrmOpportunity records by their Ids in a single request.

Get one CrmOpportunity

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

import requests

url = "https://spaces.nexudus.com/api/crm/crmopportunities/{id}"

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/crm/crmopportunities/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

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

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200