Kommo

Pipelines

GET
/v1/kommo/pipelines

Retorna pipelines do Kommo com estágios e metadados de status.

Filtros:

  • organizationId (obrigatório)
  • integrationId (opcional)
  • pipelineName, pipelineId
  • statusId, statusName
  • sort, color, type

Autorização

ClientIdAuthClientSecretAuth
headerx-client-id<token>

Client ID

headerx-client-secret<token>

Client secret

Parâmetros de query

organizationId*string

Identificador da organização (obrigatório)

integrationId?string

Identificador da integração (opcional)

pipelineName?string

Nome do pipeline (opcional)

pipelineId?string

Identificador do pipeline (opcional)

statusId?string

Identificador do status (opcional)

statusName?string

Nome do status (opcional)

sort?integer

Ordem de classificação (opcional)

color?string

Cor do pipeline (opcional)

type?string

Tipo do pipeline (opcional)

page?integer

Número da página para paginação (opcional)

Padrão1
limit?integer

Número de itens por página (opcional, máx. 5000)

Intervalovalue <= 5000
Padrão500

Corpo da resposta

Resposta de sucesso

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