---
updatedAt: 2026-05-29T10:05:49.000Z
agentTools:
  projectIndex: https://pt-developers.kommo.com/llms.txt
---

# Obter um Salesbot pelo ID

Este método permite obter um Salesbot pelo seu ID.

**Limitações**\
O método está disponível para todos os usuários da conta.

**Parâmetros "with"**

| Parâmetro | Descrição                                                                                                                |
| :-------- | :----------------------------------------------------------------------------------------------------------------------- |
| favorite  | Adiciona a propriedade `is_favorite` á resposta, que define se o Salesbot foi adicionado aos favoritos do usuário atual. |

**Cabeçalho do tipo de dado para quando a requisição é bem-sucedida**\
Content-Type: application/hal+json

**Cabeçalho do tipo de dado em casos de erro**\
Content-Type: application/problem+json

## Parâmetros de resposta

| Parâmetro           | Tipo de dado | Descrição                                                                                                                                                                                                  |
| :------------------ | :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id                  | int          | ID do Salesbot                                                                                                                                                                                             |
| name                | string       | Nome do Salesbot                                                                                                                                                                                           |
| is\_visual\_editor  | bool         | Define o tipo de editor do Salesbot. `true` indica que o Salesbot está no modo de edição visual; `false` indica que o Salesbot está no modo de edição em código/texto.                                     |
| type\_functionality | string       | Tipo de funcionalidade do Salesbot: `regular` – Salesbot de fluxo de trabalho básico, `greeting` – Bot de mensagem de boas-vindas, `marketing` – Transmissão de mensagens, `nps` – Bot de pesquisa de NPS. |
| settings            | obj          | Configurações do Salesbot.                                                                                                                                                                                 |
| settings\[active]   | bool         | Define se o Salesbot está ativo.                                                                                                                                                                           |
| is\_favorite        | bool         | **Necessária definição no parâmetro `with`.** Define se o Salesbot foi adicionado aos favoritos.                                                                                                           |

<br />

# 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/bots/{id}": {
      "get": {
        "description": "Este método permite obter um Salesbot pelo seu ID.",
        "responses": {
          "200": {
            "description": "Requisição bem-sucedida",
            "content": {
              "application/hal+json": {
                "examples": {
                  "Requisição bem-sucedida": {
                    "summary": "Requisição bem-sucedida",
                    "value": {
                      "id": 12345,
                      "name": "Salesbot",
                      "type_functionality": "regular",
                      "is_visual_editor": true,
                      "settings": {
                        "active": false
                      },
                      "_links": {
                        "self": {
                          "href": "https://subdomain.kommo.com/api/v4/bots/12345/"
                        }
                      }
                    }
                  }
                },
                "schema": {
                  "type": "object",
                  "properties": {
                    "id": {
                      "type": "integer",
                      "example": 12345,
                      "default": 0
                    },
                    "name": {
                      "type": "string",
                      "example": "Salesbot"
                    },
                    "type_functionality": {
                      "type": "string",
                      "example": "regular"
                    },
                    "is_visual_editor": {
                      "type": "boolean",
                      "example": true,
                      "default": true
                    },
                    "settings": {
                      "type": "object",
                      "properties": {
                        "active": {
                          "type": "boolean",
                          "example": false,
                          "default": true
                        }
                      }
                    },
                    "_links": {
                      "type": "object",
                      "properties": {
                        "self": {
                          "type": "object",
                          "properties": {
                            "href": {
                              "type": "string",
                              "example": "https://subdomain.kommo.com/api/v4/bots/12345/"
                            }
                          }
                        }
                      }
                    }
                  }
                }
              }
            }
          },
          "204": {
            "content": {
              "text/html": {
                "schema": {
                  "type": "object",
                  "properties": {}
                },
                "examples": {
                  "Salesbot com o ID especificado inexistente": {
                    "summary": "Salesbot com o ID especificado inexistente",
                    "value": "No content"
                  }
                }
              }
            },
            "description": "Salesbot com o ID especificado inexistente"
          },
          "400": {
            "content": {
              "application/problem+json": {
                "schema": {
                  "type": "object",
                  "properties": {}
                },
                "examples": {
                  "Dados incorretos foram transmitidos. Detalhes disponíveis no corpo da resposta.": {
                    "summary": "Dados incorretos foram transmitidos. Detalhes disponíveis no corpo da resposta.",
                    "value": ""
                  }
                }
              }
            },
            "description": "Dados incorretos foram transmitidos. Detalhes disponíveis no corpo da resposta."
          },
          "401": {
            "content": {
              "application/problem+json": {
                "schema": {
                  "type": "object",
                  "properties": {}
                },
                "examples": {
                  "Usuário não autorizado": {
                    "summary": "Usuário não autorizado",
                    "value": "{\n  \"title\": \"Não autorizado\",\n  \"type\": \"https://httpstatus.es/401\",\n  \"status\": 401,\n  \"detail\": \"Usuário ou senha inválidos\"\n}"
                  }
                }
              }
            },
            "description": "Usuário não autorizado"
          }
        },
        "parameters": [
          {
            "in": "path",
            "name": "id",
            "schema": {
              "type": "integer"
            },
            "required": true,
            "description": "ID do Salesbot"
          },
          {
            "in": "query",
            "name": "with",
            "schema": {
              "type": "string"
            },
            "description": "Este parâmetro aceita uma string que pode consistir de vários valores separados por vírgulas."
          }
        ],
        "operationId": "get_api-v4-bots-id",
        "summary": "Obter um Salesbot pelo ID"
      }
    }
  },
  "x-readme": {
    "headers": [],
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "x-readme-fauxas": true
}
```