---
title: "List all pipelines"
---

> Documentation Index
> Fetch the complete documentation index at: https://developer.channelautomations.com/llms.txt
> Use this file to discover all available pages before exploring further.

Path: Channel Automation API › Pipeline

`GET /api/pipeline/pipelines`

## Authentication

- `bearerAuth`

## Code samples

### cURL

```bash
curl --request GET \
  --url https://api.channelautomation.com/api/pipeline/pipelines
```

### TypeScript

```typescript
const url = 'https://api.channelautomation.com/api/pipeline/pipelines';
const options = {method: 'GET'};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://api.channelautomation.com/api/pipeline/pipelines"

response = requests.get(url)

print(response.text)
```

## Responses

### 200

A list of pipelines

#### Example

```json
{
  "success": true,
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "workspace_id": "string",
      "is_default": true,
      "is_active": true,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
      "opportunity_count": 0,
      "total_value": 0,
      "stages": [
        {
          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
          "name": "string",
          "position": 0,
          "color": "string",
          "default_probability": 0,
          "is_won_stage": true,
          "is_lost_stage": true,
          "opportunity_count": 0
        }
      ]
    }
  ]
}
```

- `success` (`get/api/pipeline/pipelines.response.200.success`; boolean, optional)
- `data` (`get/api/pipeline/pipelines.response.200.data`; array<object>, optional)
  - `id` (`get/api/pipeline/pipelines.response.200.data.id`; string, optional) — Unique pipeline identifier
    - format `uuid`
  - `name` (`get/api/pipeline/pipelines.response.200.data.name`; string, optional) — Name of the pipeline
  - `description` (`get/api/pipeline/pipelines.response.200.data.description`; string, optional) — Description of the pipeline
  - `workspace_id` (`get/api/pipeline/pipelines.response.200.data.workspace_id`; string, optional) — Workspace ID this pipeline belongs to
  - `is_default` (`get/api/pipeline/pipelines.response.200.data.is_default`; boolean, optional) — Whether this is the default pipeline
  - `is_active` (`get/api/pipeline/pipelines.response.200.data.is_active`; boolean, optional) — Whether this pipeline is active
  - `created_at` (`get/api/pipeline/pipelines.response.200.data.created_at`; string, optional) — Creation timestamp
    - format `date-time`
  - `updated_at` (`get/api/pipeline/pipelines.response.200.data.updated_at`; string, optional) — Last update timestamp
    - format `date-time`
  - `created_by` (`get/api/pipeline/pipelines.response.200.data.created_by`; string, optional) — User ID who created the pipeline
    - format `uuid`
  - `opportunity_count` (`get/api/pipeline/pipelines.response.200.data.opportunity_count`; integer, optional) — Number of opportunities in this pipeline
  - `total_value` (`get/api/pipeline/pipelines.response.200.data.total_value`; number, optional) — Total value of all opportunities in this pipeline
  - `stages` (`get/api/pipeline/pipelines.response.200.data.stages`; array<object>, optional)
    - `id` (`get/api/pipeline/pipelines.response.200.data.stages.id`; string, optional) — Unique stage identifier
      - format `uuid`
    - `name` (`get/api/pipeline/pipelines.response.200.data.stages.name`; string, optional) — Name of the stage
    - `position` (`get/api/pipeline/pipelines.response.200.data.stages.position`; integer, optional) — Order position in the pipeline
    - `color` (`get/api/pipeline/pipelines.response.200.data.stages.color`; string, optional) — Color code for the stage
    - `default_probability` (`get/api/pipeline/pipelines.response.200.data.stages.default_probability`; integer, optional) — Default probability percentage for opportunities in this stage
    - `is_won_stage` (`get/api/pipeline/pipelines.response.200.data.stages.is_won_stage`; boolean, optional) — Whether this is a won/success stage
    - `is_lost_stage` (`get/api/pipeline/pipelines.response.200.data.stages.is_lost_stage`; boolean, optional) — Whether this is a lost/failed stage
    - `opportunity_count` (`get/api/pipeline/pipelines.response.200.data.stages.opportunity_count`; integer, optional) — Number of opportunities in this stage

### 401

Unauthorized

### 500

Internal server error


Source: https://developer.channelautomations.com/api/get-api-pipeline-pipelines/index.md