# Pipelines

## get_pipelines

`TOOL get_pipelines`

Get list of pipelines for the authenticated user's organization

Authentication: no security requirement declared for this operation.

Parameters:

- `page` (argument, number, optional) - Page number for pagination
  Type: number
  
  Page number for pagination
  
  default: 1

- `limit` (argument, number, optional) - Number of items per page
  Type: number
  
  Number of items per page
  
  default: 10

- `search` (argument, string, optional) - Search term for pipeline name or description
  Type: string
  
  Search term for pipeline name or description

- `relations` (argument, array, optional) - Relations to include
  Type: array
  
  Relations to include
  
  Items:
    Type: string

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## get_pipeline

`TOOL get_pipeline`

Get a specific pipeline by ID

Authentication: no security requirement declared for this operation.

Parameters:

- `id` (argument, string, uuid, required) - The pipeline ID
  Type: string, uuid
  
  The pipeline ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `relations` (argument, array, optional) - Relations to include
  Type: array
  
  Relations to include
  
  Items:
    Type: string

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## create_pipeline

`TOOL create_pipeline`

Create a new pipeline in the authenticated user's organization

Authentication: no security requirement declared for this operation.

Request body: application/json (required)

Type: object

- `pipeline_data` (required)
  Type: object
  
  The data for creating the pipeline
  
  - `name` (required)
    Type: string
    
    The name (required)
  
  Additional properties: 
    Type: unknown

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## update_pipeline

`TOOL update_pipeline`

Update an existing pipeline

Authentication: no security requirement declared for this operation.

Parameters:

- `id` (argument, string, uuid, required) - The pipeline ID
  Type: string, uuid
  
  The pipeline ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `pipeline_data` (argument, object, required) - The data for updating the pipeline
  Type: object
  
  The data for updating the pipeline
  
  Additional properties: 
    Type: unknown

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## delete_pipeline

`TOOL delete_pipeline`

Delete a pipeline

Authentication: no security requirement declared for this operation.

Parameters:

- `id` (argument, string, uuid, required) - The pipeline ID
  Type: string, uuid
  
  The pipeline ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

## Examples

### JSON-RPC

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

### TypeScript

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

### Python

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


## add_pipeline_stage

`TOOL add_pipeline_stage`

Add a stage to a pipeline

Authentication: no security requirement declared for this operation.

Request body: application/json (required)

Type: object

- `pipelineId` (required)
  Type: string, uuid
  
  The pipeline ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `stage_data` (required)
  Type: object
  
  The stage data
  
  - `name` (required)
    Type: string
    
    Stage name
  
  - `probability` (optional)
    Type: number
    
    Win probability percentage
    
    minimum: 0
    
    maximum: 100
  
  - `description` (optional)
    Type: string
    
    Stage description

## Examples

### JSON-RPC

```json
{
  "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"
        }
      }
  }
}
```

### TypeScript

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

### Python

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


## update_pipeline_stage

`TOOL update_pipeline_stage`

Update a pipeline stage

Authentication: no security requirement declared for this operation.

Request body: application/json (required)

Type: object

- `pipelineId` (required)
  Type: string, uuid
  
  The pipeline ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `stageId` (required)
  Type: string, uuid
  
  The stage ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `stage_data` (required)
  Type: object
  
  The stage data to update
  
  - `name` (optional)
    Type: string
    
    Stage name
  
  - `probability` (optional)
    Type: number
    
    Win probability percentage
    
    minimum: 0
    
    maximum: 100
  
  - `description` (optional)
    Type: string
    
    Stage description

## Examples

### JSON-RPC

```json
{
  "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"
        }
      }
  }
}
```

### TypeScript

```typescript
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"
    }
  }
});
```

### Python

```python
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"
  }
})
```


## remove_pipeline_stage

`TOOL remove_pipeline_stage`

Remove a stage from a pipeline

Authentication: no security requirement declared for this operation.

Parameters:

- `pipelineId` (argument, string, uuid, required) - The pipeline ID
  Type: string, uuid
  
  The pipeline ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

- `stageId` (argument, string, uuid, required) - The stage ID
  Type: string, uuid
  
  The stage ID
  
  pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"

## Examples

### JSON-RPC

```json
{
  "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"
      }
  }
}
```

### TypeScript

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

### Python

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