CRM
Get an opportunity
Returns the record of an opportunity: the summary plus the description, the collaborators and the linked quotes.
crm:readResult
generated from the schema
With includeHistory=true it adds stageHistory, the stage moves from most recent to oldest — it is an additional query, so it does not come by default.
Arguments
Opportunity identifier.
Limits: min length 1
Result
On success the result carries structuredContent with data and meta. These are the attributes of data.
Show the attributes of data
Available options: open, won, lost
Available options: open, won, lost
Available options: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner, other
Limits: min 1
Show child attributesHide child attributes
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs GET /api/v1/crm/opportunities/{opportunityId}.
Related pages
Link to this section: Related pagesCRM
Get an opportunity
Returns the record of an opportunity: the summary plus the description, the collaborators and the linked quotes.
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with
isError: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?