get https://{subdomain}.kommo.com/api/v4/account
O método permite obter as informações da conta.
Limitações
O método está disponível para todos os usuários da conta.
Parâmetros “with”
| Parâmetro | Descrição |
|---|---|
| amojo_id | Adiciona o ID da conta no serviço de chat online à resposta |
| amojo_rights | Adiciona na resposta informações sobre a disponibilidade da funcionalidade para criação de grupos e uso de chats diretos pelos usuários |
| users_groups | Adiciona à resposta informações sobre os grupos disponíveis de usuários da conta |
| task_types | Adiciona à resposta informações sobre os tipos de tarefas disponíveis na conta |
| version | Adiciona informações sobre a versão atual da Kommo à resposta |
| entity_names | Adiciona nomes de entidades à resposta com suas traduções e formas numéricas |
| datetime_settings | Adiciona à resposta informações sobre as configurações atuais de formatos de data e hora da conta |
| drive_url | Adiciona o endereço do serviço de arquivos para a conta solicitada |
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 | 'with' obrigatório? | Descrição |
|---|---|---|---|
| id | int | ❌ | ID da Conta |
| name | string | ❌ | Nome da Conta |
| subdomain | string | ❌ | Subdomínio da Conta |
| current_user_id | int | ❌ | ID do usuário atual |
| country | string | ❌ | País especificado nas configurações da conta |
| currency | string | ❌ | Moeda especificada nas configurações da conta |
| currency_symbol | string | ❌ | Símbolo da moeda |
| is_unsorted_on | bool | ❌ | A funcionalidade Leads de Entrada está habilitada? |
| is_loss_reason_enabled | bool | ❌ | A funcionalidade Motivo para leads perdidos está habilitada? |
| is_helpbot_enabled | bool | ❌ | A funcionalidade AI power-up está habilitada? (disponível apenas no plano Enterprise) |
| is_technical_account | bool | ❌ | A conta é técnica? |
| contact_name_display_order | int | ❌ | Define a ordem do nome do contato (1 – Nome, Sobrenome; 2 – Sobrenome, Nome). |
| amojo_id | string | ✅ | Identificador único da conta no serviço de chat online amojo. |
| version | int | ✅ | Versão atual da Kommo |
| _embedded[amojo_rights] | obj | ✅ | Objeto de configurações de chats |
| _embedded[amojo_rights][can_direct] | obj | ✅ | Define se chats internos estão disponíveis. |
| _embedded[amojo_rights][can_create_groups] | obj | ✅ | Define se chats em grupo estão disponíveis. |
| _embedded[users_groups] | array | ✅ | Array de objetos dos grupos de usuários do Kommo |
| _embedded[users_groups][0][id] | int | ✅ | ID do grupo de usuários |
| _embedded[users_groups][0][name] | string | ✅ | Nome do grupo de usuários |
| _embedded[task_types] | array | ✅ | Tipos de tarefas na conta |
| _embedded[task_types][0][id] | int | ✅ | ID do tipo de tarefa |
| _embedded[task_types][0][name] | string | ✅ | Nome do tipo de tarefa |
| _embedded[task_types][0][color] | string | ✅ | Cor do tipo de tarefa |
| _embedded[task_types][0][icon_id] | int | ✅ | ID do ícone do tipo de tarefa |
| _embedded[task_types][0][code] | string | ✅ | Código do tipo de tarefa |
| _embedded[datetime_settings] | obj | ✅ | Configurações de data e hora e formato na conta |
| _embedded[entity_names] | obj | ✅ | Configurações de nomes de entidades |