*REST API › Endpoint reference › CRM*

# List pipelines

> Returns the pipelines of the account with their ordered stages.

Use it to resolve `pipelineId` and `stageId` of the opportunities listing without guessing identifiers. It does NOT paginate: an account has a handful of pipelines and all of them are returned.

`GET /api/v1/crm/pipelines` — scope `crm:read`

Scope: `crm:read` · 120/min · Strict tenancy · Add-on (402) · MCP: `filmo_crm_pipelines_list`

## Authorizations

Bearer API key with the scope below. `crm:read`

## Query parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `includeArchived` | boolean | No | If "true", archived pipelines are included as well. By default only the active ones are returned. = `false` |

## Request examples

*List pipelines*

**cURL**

```bash
curl https://app.filmo.io/api/v1/crm/pipelines \
  --header "Authorization: Bearer $FILMO_API_KEY"
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/crm/pipelines', {
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY'
  }
})
```

**Python**

```python
import requests

requests.get(
    "https://app.filmo.io/api/v1/crm/pipelines",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY"
    }
)
```

## Response

Response schema: `PipelineDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 402 | Add-on required (addon_required): the account plan does not include the add-on this operation needs; `requiredAddon` names it. |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object[] |  |
| `data.pipelineId` | string |  |
| `data.name` | string |  |
| `data.slug` | string |  |
| `data.isDefault` | boolean |  |
| `data.isArchived` | boolean |  |
| `data.totalOpportunities` | integer |  |
| `data.totalValue` | string |  |
| `data.stages` | object[] |  |
| `data.stages.stageId` | string |  |
| `data.stages.name` | string |  |
| `data.stages.order` | integer |  |
| `data.stages.type` | string |  `open`, `won`, `lost` |
| `data.stages.probability` | number |  |
| `data.stages.isDefault` | boolean |  |
| `data.createdAt` | string<date-time> |  |
| `data.updatedAt` | string<date-time> |  |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": [
    {
      "pipelineId": "pipeline_9f3a2b",
      "name": "Example pipeline",
      "slug": "Example slug",
      "isDefault": true,
      "isArchived": true,
      "totalOpportunities": 1,
      "totalValue": "120.00",
      "stages": [
        {
          "stageId": "stage_9f3a2b",
          "name": "Example stage",
          "order": 1,
          "type": "open",
          "probability": 1,
          "isDefault": true
        }
      ],
      "createdAt": "2026-09-01T10:00:00+02:00",
      "updatedAt": "2026-09-01T10:00:00+02:00"
    }
  ]
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 402 | `addon_required` | The account plan does not include the add-on this operation needs; `requiredAddon` names it. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/crm/list-pipelines  
Last updated: 2026-10-25