CRM
List opportunities
Returns the sales opportunities with their pipeline, their stage and their amount weighted by the probability of the stage.
crm:readResult
generated from the schema
By default only the open ones: pass status=won, lost or all for the rest. It paginates by a cursor specific to the CRM service.
Arguments
Page size (1-500). Defaults to 50.
Limits: min 1, max 500
Opaque cursor of the page to return. Pass the value of pagination. from the previous response; treat it as opaque.
Limits: max length 200
Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, name, identifier, status, amount, expectedCloseDate. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.
Limits: max length 200
Returns only the opportunities in this pipeline.
Returns only the opportunities in this stage.
Commercial status: open (the default), won, lost or all.
Available options: open, won, lost, all
Returns only the opportunities of this contact.
Free-text search on the name and the identifier.
Expected close date from this date (ISO 8601).
Expected close date up to this date (ISO 8601).
Set it to true to include pagination., the number of results that match the filters across all pages. Off by default.
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
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.
Related pages
Link to this section: Related pagesCRM
List opportunities
Returns the sales opportunities with their pipeline, their stage and their amount weighted by the probability of the stage.
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?