Kommo

Pipelines

GET
/v1/kommo/pipelines

Retrieve Kommo pipelines with stages and status metadata.

Filters:

  • organizationId (required)
  • integrationId (optional)
  • pipelineName, pipelineId
  • statusId, statusName
  • sort, color, type

Authorization

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Query Parameters

organizationId*string

Organization identifier (required)

integrationId?string

Integration identifier (optional)

pipelineName?string

Pipeline name (optional)

pipelineId?string

Pipeline identifier (optional)

statusId?string

Status identifier (optional)

statusName?string

Status name (optional)

sort?integer

Sort order (optional)

color?string

Pipeline color (optional)

type?string

Pipeline type (optional)

page?integer

Page number for pagination (optional)

Default1
limit?integer

Number of items per page (optional, max 5000)

Rangevalue <= 5000
Default500

Response Body

Successful response

application/json
  1. response
data?array<>
meta?
curl -X GET "https://example.com/v1/kommo/pipelines?organizationId=organization_123"
{  "data": [    {      "pipeline_id": "string",      "pipeline_name": "string",      "pipeline_sort": 0,      "status_id": "string",      "status_name": "string",      "sort": 0,      "is_editable": true,      "color": "string",      "type": "string",      "integration_id": "string",      "organization_id": "string",      "document_id": "string",      "inserted_at": "2019-08-24T14:15:22Z"    }  ],  "meta": {    "page": 0,    "limit": 0,    "hasNextPage": true,    "hasPreviousPage": true  }}