Opportunities
Get Opportunity
Read one opportunity, including its status and notes
GET
Read a single opportunity by the ID that search results return. This is where the
notes and status written by Update Opportunity
come back: notes are stored on the opportunity and are returned here and in the
tracking block on search results, nowhere else.
To append to a note, read it first.
notes on the update endpoint replaces
whatever is there. Fetch the current value here, concatenate, and send the combined
text back.A status is a tag now. The
tracking.status_* fields are still returned when a
status is set, but triage moved to tags in this release, so for most opportunities
they will be empty. Read an intro’s triage state with Get An Opportunity’s
Tags, the same vocabulary
Update Opportunity writes through.Path Parameters
string
required
Opportunity ID (from search results)
Query Parameters
boolean
Include the full engagement history rather than the totals alone.
boolean
Include every job each person holds or held, alongside the single role the
opportunity is filed under.
Response
The opportunity in the same shape the searches return it, plus the connector it came through. Thetracking object is present only when a status, notes or an assignment
have been set — it is where an intro stands with your team, and has nothing to do with
Workflows, the automation builder in the app:
string
The status the opportunity was moved to — one of the IDs from
List Opportunity Statuses.
string
Your workspace’s label for that status.
string
Hex colour configured for the status.
boolean
Whether the status closes the opportunity (won or lost).
string
Free text last written by Update Opportunity.
string
When the opportunity was first assigned.