CRM

Pipeline

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

Schemas: PipelineDto

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

Generated from the schema

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.

Attributes

pipelineIdstring

namestring

slugstring

isDefaultboolean

isArchivedboolean

totalOpportunitiesinteger

totalValuestring

stagesobject[]

Show child attributes

stages.stageIdstring

stages.namestring

stages.orderinteger

stages.typestring

Available options: open, won, lost

stages.probabilitynumber

stages.isDefaultboolean

createdAtstring<date-time>

updatedAtstring<date-time>

Returned by

GET /api/v1/crm/pipelines — List pipelines
GET /api/v1/crm/pipelines/{pipelineId} — Get a pipeline

Modified by

No operation.

Was this page helpful?