CrmOpportunities
Get one CrmOpportunity
Retrieve a single CrmOpportunity record by its Id.
GET
Get one CrmOpportunity
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, orLost. Stages withWinOpportunityorLoseOpportunityupdate 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.
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
The Id of the CrmOpportunity record to retrieve.
Code Examples
Response
200
Optional tag to identify this opportunity, useful when the same customer appears in multiple boards.
Crm Board Column Id.
CRM stage name.
CRM board ID.
CRM board name.
Business ID of the CRM board.
Business name of the CRM board.
Currency ID of the CRM board’s business.
Currency code of the CRM board’s business.
Coworker Id.
Customer full name.
Customer record type.
Customer company name.
Customer email address.
Team Id.
Team name.
Team description.
Team profile website.
Opportunity type used to categorise and auto-populate general notes from a template.
Opportunity type name.
Admin user responsible for managing this opportunity.
Responsible admin full name.
Customer who referred this opportunity.
External agent or broker who brought this opportunity.
General notes visible to admins when viewing the opportunity. Auto-populated from the opportunity type template if a type is assigned.
Whether the opportunity has been completed (won or lost).
Follow-up date for the opportunity.
Expected revenue if the opportunity is won.
Whether a follow-up reminder has been sent for this opportunity.
How the opportunity was acquired (e.g. Web, Phone, Referral, Broker, GoogleSearch).
Why the opportunity was lost (e.g. Price, Competition, Location). Only relevant when Status is Lost.
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.Date when the opportunity was marked as won.
Date when the opportunity was marked as lost.
Timestamp of the last CRM-related update to this opportunity.
Display order of the opportunity within its current stage.
UTM source parameter captured from the URL the opportunity used.
UTM medium parameter captured from the URL the opportunity used.
UTM campaign parameter captured from the URL the opportunity used.
UTM content parameter captured from the URL the opportunity used.
UTM term parameter captured from the URL the opportunity used.
Unique record identifier.
UUID of the record.
Date and time the record was created (ISO 8601).
Date and time the record was last updated (ISO 8601).
Email of the user who last updated this record.
Whether the record was recently created.
External system identifier.
Example Response
Get one CrmOpportunity