CRM

List opportunities

Returns the sales opportunities with their pipeline, their stage and their amount weighted by the probability of the stage.

Tool
filmo_crm_opportunities_list
Access: Read
  • crm:read
  • 120/min
  • May need an add-on
  • Server annotation: Read-only
  • Server annotation: Idempotent

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_crm_opportunities_list",
    "arguments": {
      "limit": 20
    }
  }
}

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

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

sortstring

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

pipelineIdstring

Returns only the opportunities in this pipeline.

stageIdstring

Returns only the opportunities in this stage.

statusstring

Commercial status: open (the default), won, lost or all.

Available options: open, won, lost, all

contactIdstring

Returns only the opportunities of this contact.

qstring

Free-text search on the name and the identifier.

expectedCloseFromstring

Expected close date from this date (ISO 8601).

expectedCloseTostring

Expected close date up to this date (ISO 8601).

includeTotalbooleandefault:false

Set it to true to include pagination.total, 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
opportunityIdstring

identifierstring

namestring

statusstring

Available options: open, won, lost

amountstring

currencystring

pipelineIdstring

pipelineNamestring

stageIdstring

stageNamestring

stageTypestring

Available options: open, won, lost

effectiveProbabilitynumber

weightedAmountstring

daysInStageinteger

expectedCloseDatestring<date-time>

contactNamestring

companyNamestring

ownerNamestring

sourcestring

Available options: inbound_email, website_form, referral, cold_outreach, event, social, existing_customer, partner, other

createdAtstring<date-time>

updatedAtstring<date-time>

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/crm/opportunities.

  • CRM

    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: true and the problem in the first text block. Branch on its code.