Pipelines

get_pipelines

Get list of pipelines for the authenticated user's organization

get_pipelines

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_pipelines",
    "arguments": {
        "page": 1,
        "limit": 10,
        "search": "string",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_pipelines",
  "arguments": {
    "page": 1,
    "limit": 10,
    "search": "string",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_pipelines", arguments={
  "page": 1,
  "limit": 10,
  "search": "string",
  "relations": [
    "string"
  ]
})

Parameters

pagenumber1

Page number for pagination

limitnumber10

Number of items per page

searchstring

Search term for pipeline name or description

relationsArray<string>

Relations to include

get_pipeline

Get a specific pipeline by ID

get_pipeline

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_pipeline",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "relations": [
          "string"
        ]
      }
  }
}

const result = await client.callTool({
  "name": "get_pipeline",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "relations": [
      "string"
    ]
  }
});

result = await session.call_tool("get_pipeline", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "relations": [
    "string"
  ]
})

Parameters

idstring<uuid>required

The pipeline ID

relationsArray<string>

Relations to include

create_pipeline

Create a new pipeline in the authenticated user's organization

create_pipeline

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "create_pipeline",
    "arguments": {
        "pipeline_data": {
          "name": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "create_pipeline",
  "arguments": {
    "pipeline_data": {
      "name": "string"
    }
  }
});

result = await session.call_tool("create_pipeline", arguments={
  "pipeline_data": {
    "name": "string"
  }
})

Request Body

{
  "pipeline_data": {
    "name": "string"
  }
}

Body

application/json

pipeline_dataobjectrequired

The data for creating the pipeline

Show child attributes

namestringrequired

The name (required)

[key: string]any

update_pipeline

Update an existing pipeline

update_pipeline

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_pipeline",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "pipeline_data": {}
      }
  }
}

const result = await client.callTool({
  "name": "update_pipeline",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "pipeline_data": {}
  }
});

result = await session.call_tool("update_pipeline", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "pipeline_data": {}
})

Parameters

idstring<uuid>required

The pipeline ID

pipeline_dataobjectrequired

The data for updating the pipeline

delete_pipeline

Delete a pipeline

delete_pipeline

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "delete_pipeline",
    "arguments": {
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "delete_pipeline",
  "arguments": {
    "id": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("delete_pipeline", arguments={
  "id": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

idstring<uuid>required

The pipeline ID

add_pipeline_stage

Add a stage to a pipeline

add_pipeline_stage

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "add_pipeline_stage",
    "arguments": {
        "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
        "stage_data": {
          "name": "string",
          "probability": 0,
          "description": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "add_pipeline_stage",
  "arguments": {
    "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
    "stage_data": {
      "name": "string",
      "probability": 0,
      "description": "string"
    }
  }
});

result = await session.call_tool("add_pipeline_stage", arguments={
  "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
  "stage_data": {
    "name": "string",
    "probability": 0,
    "description": "string"
  }
})

Request Body

{
  "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
  "stage_data": {
    "name": "string",
    "probability": 0,
    "description": "string"
  }
}

Body

application/json

pipelineIdstring<uuid>required

The pipeline ID

stage_dataobjectrequired

The stage data

Show child attributes

namestringrequired

Stage name

probabilitynumber[0, 100]

Win probability percentage

descriptionstring

Stage description

update_pipeline_stage

Update a pipeline stage

update_pipeline_stage

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "update_pipeline_stage",
    "arguments": {
        "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
        "stageId": "550e8400-e29b-41d4-a716-446655440000",
        "stage_data": {
          "name": "string",
          "probability": 0,
          "description": "string"
        }
      }
  }
}

const result = await client.callTool({
  "name": "update_pipeline_stage",
  "arguments": {
    "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
    "stageId": "550e8400-e29b-41d4-a716-446655440000",
    "stage_data": {
      "name": "string",
      "probability": 0,
      "description": "string"
    }
  }
});

result = await session.call_tool("update_pipeline_stage", arguments={
  "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
  "stageId": "550e8400-e29b-41d4-a716-446655440000",
  "stage_data": {
    "name": "string",
    "probability": 0,
    "description": "string"
  }
})

Request Body

{
  "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
  "stageId": "550e8400-e29b-41d4-a716-446655440000",
  "stage_data": {
    "name": "string",
    "probability": 0,
    "description": "string"
  }
}

Body

application/json

pipelineIdstring<uuid>required

The pipeline ID

stageIdstring<uuid>required

The stage ID

stage_dataobjectrequired

The stage data to update

Show child attributes

namestring

Stage name

probabilitynumber[0, 100]

Win probability percentage

descriptionstring

Stage description

remove_pipeline_stage

Remove a stage from a pipeline

remove_pipeline_stage

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "remove_pipeline_stage",
    "arguments": {
        "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
        "stageId": "550e8400-e29b-41d4-a716-446655440000"
      }
  }
}

const result = await client.callTool({
  "name": "remove_pipeline_stage",
  "arguments": {
    "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
    "stageId": "550e8400-e29b-41d4-a716-446655440000"
  }
});

result = await session.call_tool("remove_pipeline_stage", arguments={
  "pipelineId": "550e8400-e29b-41d4-a716-446655440000",
  "stageId": "550e8400-e29b-41d4-a716-446655440000"
})

Parameters

pipelineIdstring<uuid>required

The pipeline ID

stageIdstring<uuid>required

The stage ID

Stack Overflow Website Demo