--- updatedAt: 2025-07-22T09:06:45.000Z agentTools: projectIndex: https://pt-developers.kommo.com/llms.txt --- # Obtendo um pipeline pelo seu ID Este método permite obter um objeto de pipeline, especificando o ID do pipeline desejado **Limitações**\ O método está disponível para todos os usuários da conta. **Tipo de autorização**\ OAuth 2.0 com Token de Acesso / Token de Longa Duração **Cabeçalho de tipo de dado quando a solicitação é bem-sucedida**\ Content-Type: application/hal+json **Cabeçalho de tipo de dado em caso de erro**\ Content-Type: application/problem+json ## Parâmetros de resposta | Parâmetro | Tipo de dado | Descrição | | :-------------------- | :----------- | :----------------------------------------------- | | id | int | ID do Pipeline | | name | string | Nome do Pipeline | | sort | int | Define a ordem de exibição do pipeline na lista | | is\_main | bool | Define se o pipeline é principal para a conta | | is\_unsorted\_on | bool | Define se os Leads de Entrada estão habilitados | | is\_archive | bool | Define se o pipeline está arquivado | | account\_id | string | ID da Conta onde o pipeline está localizado | | \_embedded\[statuses] | array | Dados das etapa do Pipeline | # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "referencias-de-api-da-kommo", "version": "1.1" }, "servers": [ { "url": "https://{subdomain}.kommo.com", "variables": { "subdomain": { "default": "subdomain" } } } ], "components": { "securitySchemes": { "sec0": { "type": "oauth2", "flows": {} } } }, "security": [ { "sec0": [] } ], "paths": { "/api/v4/leads/pipelines/{id}": { "get": { "summary": "Obtendo um pipeline pelo seu ID", "description": "Este método permite obter um objeto de pipeline, especificando o ID do pipeline desejado", "operationId": "obtendo-um-pipeline-pelo-seu-id", "parameters": [ { "name": "id", "in": "path", "description": "ID do Pipeline", "schema": { "type": "integer", "format": "int32" }, "required": true } ], "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Solicitação bem-sucedida": { "value": "{\n \"id\": 6950551,\n \"name\": \"Pipeline\",\n \"sort\": 1,\n \"is_main\": true,\n \"is_unsorted_on\": true,\n \"is_archive\": false,\n \"account_id\": 31361463,\n \"_links\": {\n \"self\": {\n \"href\": \"https://devteam.kommo.com/api/v4/leads/pipelines/6950551\"\n }\n },\n \"_embedded\": {\n \"statuses\": [\n {\n \"id\": 58141803,\n \"name\": \"Leads de Entrada\",\n \"sort\": 10,\n \"is_editable\": false,\n \"pipeline_id\": 6950551,\n \"color\": \"#c1c1c1\",\n \"type\": 1,\n \"account_id\": 31361463,\n \"_links\": {\n \"self\": {\n \"href\": \"https://devteam.kommo.com/api/v4/leads/pipelines/6950551/statuses/58141803\"\n }\n }\n },\n {\n \"id\": 58141807,\n \"name\": \"Contato inicial\",\n \"sort\": 20,\n \"is_editable\": true,\n \"pipeline_id\": 6950551,\n \"color\": \"#99ccff\",\n \"type\": 0,\n \"account_id\": 31361463,\n \"_links\": {\n \"self\": {\n \"href\": \"https://devteam.kommo.com/api/v4/leads/pipelines/6950551/statuses/58141807\"\n }\n }\n },\n {\n \"id\": 58141811,\n \"name\": \"Discussões\",\n \"sort\": 30,\n \"is_editable\": true,\n \"pipeline_id\": 6950551,\n \"color\": \"#ffff99\",\n \"type\": 0,\n \"account_id\": 31361463,\n \"_links\": {\n \"self\": {\n \"href\": \"https://devteam.kommo.com/api/v4/leads/pipelines/6950551/statuses/58141811\"\n }\n }\n },\n {\n \"id\": 58141815,\n \"name\": \"Tomada de decisão\",\n \"sort\": 40,\n \"is_editable\": true,\n \"pipeline_id\": 6950551,\n \"color\": \"#ffcc66\",\n \"type\": 0,\n \"account_id\": 31361463,\n \"_links\": {\n \"self\": {\n \"href\": \"https://devteam.kommo.com/api/v4/leads/pipelines/6950551/statuses/58141815\"\n }\n }\n },\n {\n \"id\": 58141819,\n \"name\": \"Discussão do contrato\",\n \"sort\": 50,\n \"is_editable\": true,\n \"pipeline_id\": 6950551,\n \"color\": \"#ffcccc\",\n \"type\": 0,\n \"account_id\": 31361463,\n \"_links\": {\n \"self\": {\n \"href\": \"https://devteam.kommo.com/api/v4/leads/pipelines/6950551/statuses/58141819\"\n }\n }\n },\n {\n \"id\": 142,\n \"name\": \"Closed - won\",\n \"sort\": 10000,\n \"is_editable\": false,\n \"pipeline_id\": 6950551,\n \"color\": \"#CCFF66\",\n \"type\": 0,\n \"account_id\": 31361463,\n \"_links\": {\n \"self\": {\n \"href\": \"https://devteam.kommo.com/api/v4/leads/pipelines/6950551/statuses/142\"\n }\n }\n },\n {\n \"id\": 143,\n \"name\": \"Closed - lost\",\n \"sort\": 11000,\n \"is_editable\": false,\n \"pipeline_id\": 6950551,\n \"color\": \"#D5D8DB\",\n \"type\": 0,\n \"account_id\": 31361463,\n \"_links\": {\n \"self\": {\n \"href\": \"https://devteam.kommo.com/api/v4/leads/pipelines/6950551/statuses/143\"\n }\n }\n }\n ]\n }\n}" } }, "schema": { "type": "object", "properties": { "id": { "type": "integer", "example": 6950551, "default": 0 }, "name": { "type": "string", "example": "Pipeline" }, "sort": { "type": "integer", "example": 1, "default": 0 }, "is_main": { "type": "boolean", "example": true, "default": true }, "is_unsorted_on": { "type": "boolean", "example": true, "default": true }, "is_archive": { "type": "boolean", "example": false, "default": true }, "account_id": { "type": "integer", "example": 31361463, "default": 0 }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "example": "https://devteam.kommo.com/api/v4/leads/pipelines/6950551" } } } } }, "_embedded": { "type": "object", "properties": { "statuses": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "example": 58141803, "default": 0 }, "name": { "type": "string", "example": "Leads de Entrada" }, "sort": { "type": "integer", "example": 10, "default": 0 }, "is_editable": { "type": "boolean", "example": false, "default": true }, "pipeline_id": { "type": "integer", "example": 6950551, "default": 0 }, "color": { "type": "string", "example": "#c1c1c1" }, "type": { "type": "integer", "example": 1, "default": 0 }, "account_id": { "type": "integer", "example": 31361463, "default": 0 }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "example": "https://devteam.kommo.com/api/v4/leads/pipelines/6950551/statuses/58141803" } } } } } } } } } } } } } } }, "401": { "description": "401", "content": { "application/json": { "examples": { "Usuário não autorizado": { "value": "{\n \"title\": \"Unauthorized\",\n \"type\": \"https://httpstatus.es/401\",\n \"status\": 401,\n \"detail\": \"Nome de usuário ou senha inválidos\"\n}" } }, "schema": { "type": "object", "properties": { "title": { "type": "string", "example": "Unauthorized" }, "type": { "type": "string", "example": "https://httpstatus.es/401" }, "status": { "type": "integer", "example": 401, "default": 0 }, "detail": { "type": "string", "example": "Nome de usuário ou senha inválidos" } } } } } }, "403": { "description": "403", "content": { "application/json": { "examples": { "Proibido": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "429": { "description": "429", "content": { "application/json": { "examples": { "Muitas solicitações": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } }, "500": { "description": "500", "content": { "application/json": { "examples": { "Erro Interno do Servidor": { "value": "{}" } }, "schema": { "type": "object", "properties": {} } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```