*REST API › Objects › CRM*

# Pipeline

> CRM pipeline with its ordered stages and, optionally, the count and total value of its opportunities.

A CRM pipeline with its ordered stages and, optionally, the count and total value of its opportunities. Opportunities move through its stages. It needs the CRM add-on: without it the answer is 402 `addon_required`.

Schemas: `PipelineDto`

## Attributes

| Name | Type | Description |
| --- | --- | --- |
| `pipelineId` | string |  |
| `name` | string |  |
| `slug` | string |  |
| `isDefault` | boolean |  |
| `isArchived` | boolean |  |
| `totalOpportunities` | integer |  |
| `totalValue` | string |  |
| `stages` | object[] |  |
| `stages.stageId` | string |  |
| `stages.name` | string |  |
| `stages.order` | integer |  |
| `stages.type` | string |  `open`, `won`, `lost` |
| `stages.probability` | number |  |
| `stages.isDefault` | boolean |  |
| `createdAt` | string<date-time> |  |
| `updatedAt` | string<date-time> |  |

## Example

*Pipeline · Generated from the schema*

```json
{
  "pipelineId": "string",
  "name": "Example",
  "slug": "string",
  "isDefault": true,
  "isArchived": true,
  "totalOpportunities": 1,
  "totalValue": "1234.50",
  "stages": [
    {
      "stageId": "string",
      "name": "Example",
      "order": 1,
      "type": "open",
      "probability": 1,
      "isDefault": true
    }
  ],
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}
```

## Returned by

- [`GET /api/v1/crm/pipelines`](https://docs.filmo.io/rest-api/endpoint-reference/crm/list-pipelines) — List pipelines
- [`GET /api/v1/crm/pipelines/{pipelineId}`](https://docs.filmo.io/rest-api/endpoint-reference/crm/get-a-pipeline) — Get a pipeline

## Modified by

No operation.

---

Canonical URL: https://docs.filmo.io/rest-api/objects/pipeline  
Last updated: 2026-10-25