Pipelines

GET

https://api.data.v4.marketing/v1/kommo/pipelines

Retrieve Kommo pipelines with stages and status metadata.

Filters:

workspaceId (required)

integrationId (optional)

organizationId (optional)

pipelineName, pipelineId

statusId, statusName

sort, color, type

Requisição

Authorization

API Key

Adicionar parâmetro em header

x-client-id

Exemplo:

x-client-id: ********************

API Key

Adicionar parâmetro em header

x-client-secret

Exemplo:

x-client-secret: ********************

Parâmetros de Consulta

Respostas

🟢200

application/json

Successful response

Body

🟠400

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.data.v4.marketing/v1/kommo/pipelines?workspaceId=workspace_123&integrationId&organizationId&pipelineName&pipelineId&statusId&statusName&sort&color&type&page&limit' \
--header 'x-client-id: <api-key>' \
--header 'x-client-secret: <api-key>'

Response Example

200 - Exemplo 1

{
    "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",
            "workspace_id": "string",
            "organization_id": "string",
            "document_id": "string",
            "inserted_at": "2019-08-24T14:15:22.123Z"
        }
    ],
    "meta": {
        "page": 0,
        "limit": 0,
        "hasNextPage": true,
        "hasPreviousPage": true
    }
}

Modificado em 2026-01-27 12:24:45