Skip to main content
GET
/
api
/
crm
/
crmopportunities
/
{id}
{
  "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>"
}

​
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 -X GET \
  "https://spaces.nexudus.com/api/crm/crmopportunities/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

​
Response

​
200

​
Name
string
Name.
​
CrmBoardColumnId
integer
Crm Board Column Id.
​
CrmBoardColumnName
string
Crm Board Column Name.
​
CrmBoardColumnCrmBoardId
integer
Crm Board Column Crm Board Id.
​
CrmBoardColumnCrmBoardName
string
Crm Board Column Crm Board Name.
​
CrmBoardColumnCrmBoardBusinessId
integer
Crm Board Column Crm Board Business Id.
​
CrmBoardColumnCrmBoardBusinessName
string
Crm Board Column Crm Board Business Name.
​
CrmBoardColumnCrmBoardBusinessCurrencyId
integer
Crm Board Column Crm Board Business Currency Id.
​
CrmBoardColumnCrmBoardBusinessCurrencyCode
string
Crm Board Column Crm Board Business Currency Code.
​
CoworkerId
integer
Coworker Id.
​
CoworkerFullName
string
Coworker Full Name.
​
CoworkerCoworkerType
string
Coworker Coworker Type.
​
CoworkerCompanyName
string
Coworker Company Name.
​
CoworkerEmail
string
Coworker Email.
​
TeamId
integer
Team Id.
​
TeamName
string
Team Name.
​
TeamDescription
string
Team Description.
​
TeamProfileWebsite
string
Team Profile Website.
​
OpportunityTypeId
integer
Opportunity Type Id.
​
OpportunityTypeName
string
Opportunity Type Name.
​
ResponsibleId
integer
Responsible Id.
​
ResponsibleFullName
string
Responsible Full Name.
​
ReferrerId
integer
Referrer Id.
​
AgentId
integer
Agent Id.
​
Notes
string
Notes.
​
Completed
boolean
Completed.
​
DueDate
string
Due Date.
​
Value
number
Value.
​
Reminded
boolean
Reminded.
​
LeadSource
integer
Lead Source.
​
LossReason
integer
Loss Reason.
​
Status
integer
Status.
​
WonOn
string
Won On.
​
LostOn
string
Lost On.
​
CrmUpdatedOn
string
Crm Updated On.
​
Position
integer
Position.
​
UtmSource
string
Utm Source.
​
UtmMedium
string
Utm Medium.
​
UtmCampaign
string
Utm Campaign.
​
UtmContent
string
Utm Content.
​
UtmTerm
string
Utm Term.
​
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": "admin@example.com",
  "IsNew": false,
  "SystemId": null,
  "ToStringText": "CrmOpportunity Example",
  "LocalizationDetails": null,
  "CustomFields": null
}