CRM

Get a pipeline

Returns a pipeline by its identifier, with its ordered stages and their type (open, won or lost).

Tool
filmo_crm_pipelines_get
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_pipelines_get",
    "arguments": {
      "pipelineId": "pipe_8f2a1c"
    }
  }
}

generated from the schema

Arguments

pipelineIdstringRequired

Pipeline 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
pipelineIdstring

namestring

slugstring

isDefaultboolean

isArchivedboolean

totalOpportunitiesinteger

totalValuestring

stagesobject[]

Show child attributes
stages.stageIdstring

stages.namestring

stages.orderinteger

stages.typestring

Available options: open, won, lost

stages.probabilitynumber

stages.isDefaultboolean

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/pipelines/{pipelineId}.

  • CRM

    Get a pipeline

    Returns a pipeline by its identifier, with its ordered stages and their type (open, won or lost).

  • 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.

Was this page helpful?