get
https://{subdomain}.kommo.com/api/v4/companies
O método permite obter uma lista de empresas.
Limitações
O método está disponível de acordo com os direitos do usuário.
Parâmetros “with”
| Parâmetro | Descrição |
|---|---|
| leads | Adiciona informações sobre os leads vinculados ao contato na resposta |
| contacts | Adiciona informações sobre os contatos vinculados à empresa na resposta |
| catalog_elements | Adiciona elementos das listas vinculados ao contato na resposta |
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
As propriedades de um objeto de empresa estão listadas abaixo.
| Parâmetro | Tipo de dado | Descrição |
|---|---|---|
| id | int | ID da Empresa |
| name | string | Nome da Empresa |
| responsible_user_id | int | ID do usuário responsável pela empresa |
| group_id | int | ID do grupo do usuário responsável pela empresa |
| created_by | int | ID do usuário que criou a empresa |
| updated_by | int | ID do usuário que atualizou a empresa por último |
| created_at | int | Data de criação da empresa no formato de Unix Timestamp |
| updated_at | int | Data de atualização da empresa no formato de Unix Timestamp |
| closest_task_at | int | Data da tarefa aberta mais próxima no formato de Unix Timestamp |
| custom_fields_values | array|null | Um array dos valores dos campos personalizados atuais da empresa |
| account_id | int | ID da conta onde a empresa está localizada |
| object | Dados das entidades incorporadas |
| array | Array de dados das tags da empresa |
| object | Modelo de tag da empresa |
| int | ID da Tag |
| string | Nome da Tag |
| string/null | Cor da Tag |
| array | O parâmetro GET “with” é obrigatório Array de dados dos contatos vinculados |
| object | Dados do contato vinculado |
| int | ID do contato vinculado |
| array | O parâmetro GET “with” é obrigatório Array de dados dos leads vinculados |
| object | Dados do lead vinculado |
| int | ID do lead vinculado |
| array | O parâmetro GET “with” é obrigatório Array de dados dos elementos de listas vinculadas |
| object | Dados do elemento da lista vinculada |
| int | ID do elemento vinculado |
| object | Metadados do elemento |
| int | Quantidade de elementos vinculados |
| int | ID da lista do elemento vinculado |