CRM

List pipelines

Returns the pipelines of the account with their ordered stages.

GET

/api/v1/crm/pipelines

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

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

{
  "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"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/addon_required",
  "title": "Add-on required",
  "status": 402,
  "code": "addon_required",
  "detail": "Your plan does not include the add-on this operation requires",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredAddon": "crm"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "crm:read"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

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.

Authorizations

Bearer API key with the scope below. crm:read

Query parameters

includeArchivedbooleandefault:false

If "true", archived pipelines are included as well. By default only the active ones are returned.

Response

application/json

Successful response.

Response schema: PipelineDto

Envelope: PipelineItems. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset

dataobject[]

Show child attributes

data.pipelineIdstring

data.namestring

data.slugstring

data.isDefaultboolean

data.isArchivedboolean

data.totalOpportunitiesinteger

data.totalValuestring

data.stagesobject[]

Show child attributes

data.stages.stageIdstring

data.stages.namestring

data.stages.orderinteger

data.stages.typestring

Available options: open, won, lost

data.stages.probabilitynumber

data.stages.isDefaultboolean

data.createdAtstring<date-time>

data.updatedAtstring<date-time>

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

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.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

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

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

Was this page helpful?

Request examples

Authorizations

Query parameters

Response

Errors

Deprecation

Related

Related pages

Pipeline