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 CRM opportunity (CrmOpportunity) is a potential customer deal in a location’s CRM board, assigned to one CRM stage and tracked from enquiry through an in-progress, won, or lost outcome; moving it to a stage can run that stage’s configured automation.

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 operator-facing label for this opportunity, useful when a customer has opportunities in multiple CRM boards..

integer

ID of the CRM stage that contains this opportunity and determines its location access; changing it moves the opportunity and runs that stage’s arrival actions..

string

Display value for CrmBoardColumn.Name..

integer

Display value for CrmBoardColumn.CrmBoard.Id..

string

Display value for CrmBoardColumn.CrmBoard.Name..

integer

Display value for CrmBoardColumn.CrmBoard.Business.Id..

string

Display value for CrmBoardColumn.CrmBoard.Business.Name..

integer

Display value for CrmBoardColumn.CrmBoard.Business.Currency.Id..

string

Display value for CrmBoardColumn.CrmBoard.Business.Currency.Code..

integer

ID of the customer this opportunity tracks; a customer is required by backend validation even though the relationship metadata is nullable..

string

Display value for Coworker.FullName..

string

Display value for Coworker.CoworkerType..

string

Display value for Coworker.CompanyName..

string

Display value for Coworker.Email..

integer

Optional ID of the team associated with this opportunity..

string

Display value for Team.Name..

string

Display value for Team.Description..

string

Display value for Team.ProfileWebsite..

integer

Optional ID of the opportunity type used to categorize this CRM opportunity..

string

Display value for OpportunityType.Name..

integer

Optional ID of the staff user responsible for following up this opportunity..

string

Display value for Responsible.FullName..

integer

Optional ID of the customer who referred this opportunity..

integer

Optional ID of the customer record representing the referring agent or broker..

string

Optional internal notes about this opportunity and its follow-up..

boolean

Whether this opportunity is marked complete; use Status to record whether it was won or lost..

string

Optional date and time by which this opportunity requires follow-up; the backend compares it against UTC for overdue CRM counts..

number

Optional expected revenue amount if this opportunity is won, in the parent CRM board location’s currency..

boolean

Whether a follow-up reminder has already been sent for this opportunity; this internal state is not exposed to Admin Tool schemas..

integer

Optional acquisition source: Web, Phone, Webinar, Referral, PrintAdvert, PurchasedList, WordOfMouth, DirectEmail, EmailMarketing, Broker, PropertyAgent, Facebook, Linkedin, Instagram, Twitter, HubbleHq, LiquidSpace, GoogleSearch, SpacePool, InstantOffices, OfficeFreedom, FlexiOffices, Workthere, Kontor, Valve, OtherSocialNetwork, or Other..

integer

Optional reason for a lost opportunity: Timing, Need, PoorQualification, Price, Feature, LostMomentum, Competition, ContractTerm, Duplicate, Waitlist, NotReturningCalls, LackOfFacilities, NoPetPolicy, NoRightFit, Location, Entrance, Errors, Archived, SearchOnHold, RelocationOnHold, or Other; use only when Status is Lost..

integer

Lifecycle status: InProgress (1) is active, Won (2) records a successful outcome, and Lost (3) records an unsuccessful outcome; setting Won or Lost stamps the matching terminal timestamp if it is empty.. See eCrmOpportunityStatus enum values: 1 = InProgress, 2 = Won, 3 = Lost.

string

Read-only UTC timestamp set when Status first becomes Won; change Status rather than setting this date directly..

string

Read-only UTC timestamp set when Status first becomes Lost; change Status rather than setting this date directly..

string

Read-only UTC timestamp automatically updated after CRM changes, including a stage move..

integer

Requested relative display order among in-progress opportunities in the current stage; the server normalizes the stage order after create or update..

string

Optional UTM source attribution captured from the URL used to submit the originating contact or sign-up form..

string

Optional UTM medium attribution captured from the URL used to submit the originating contact or sign-up form..

string

Optional UTM campaign attribution captured from the URL used to submit the originating contact or sign-up form..

string

Optional UTM content attribution captured from the URL used to submit the originating contact or sign-up form..

string

Optional UTM search-term attribution captured from the URL used to submit the originating contact or sign-up form..

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