CrmOpportunities
Get one CrmOpportunity
Retrieve a single CrmOpportunity record by its Id.
GET
Get one CrmOpportunity
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
Code Examples
Response
200
Optional operator-facing label for this opportunity, useful when a customer has opportunities in multiple CRM boards..
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..
ID of the customer this opportunity tracks; a customer is required by backend validation even though the relationship metadata is nullable..
Whether this opportunity is marked complete; use Status to record whether it was won or lost..
Optional date and time by which this opportunity requires follow-up; the backend compares it against UTC for overdue CRM counts..
Optional expected revenue amount if this opportunity is won, in the parent CRM board location’s currency..
Whether a follow-up reminder has already been sent for this opportunity; this internal state is not exposed to Admin Tool schemas..
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..
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..
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.Read-only UTC timestamp set when Status first becomes Won; change Status rather than setting this date directly..
Read-only UTC timestamp set when Status first becomes Lost; change Status rather than setting this date directly..
Requested relative display order among in-progress opportunities in the current stage; the server normalizes the stage order after create or update..
Optional UTM source attribution captured from the URL used to submit the originating contact or sign-up form..
Optional UTM medium attribution captured from the URL used to submit the originating contact or sign-up form..
Optional UTM campaign attribution captured from the URL used to submit the originating contact or sign-up form..
Optional UTM content attribution captured from the URL used to submit the originating contact or sign-up form..
Optional UTM search-term attribution captured from the URL used to submit the originating contact or sign-up form..
Example Response