get https://{subdomain}.kommo.com/api/v4/roles/
Este método permite obter os dados de uma função específica pelo seu ID.
Limitações
O método é disponível apenas para usuários administradores.
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 para GET-parameters “with”
| Parâmetro | Descrição |
|---|---|
| users | Adiciona os IDs dos usuários com a função atual na resposta. |
Parâmetros de resposta
O método retorna um objeto de usuário. As propriedades do objeto estão listadas abaixo.
Objetos de direitos seguem uma estrutura comum. Dependendo do tipo de entidade, esses objetos contêm ações disponíveis como chaves e os direitos para a ação como valor.
Por exemplo, rights[leads][view]=A.
| Parâmetro | Tipo de dado | Descrição |
|---|---|---|
| id | int | ID da função |
| name | string | Nome da função |
| rights | object | Direitos de usuário |
| rights[leads] | object | Objeto de direitos de acesso a leads. |
| rights[contacts] | object | Objeto de direitos de acesso a contatos. |
| rights[companies] | object | Objeto de direitos de acesso a empresas. |
| rights[tasks] | object | Objeto de direitos de acesso a tarefas. |
| rights[mail_access] | bool | Define se a funcionalidade de e-mail é permitida para o usuário. |
| rights[catalog_access] | bool | Define se a funcionalidade de listas é permitida para o usuário. |
| rights[is_admin] | bool | Define se o usuário tem direitos de administrador. |
| rights[is_free] | bool | Define se é um usuário gratuito. |
| rights[is_active] | bool | Define se o usuário está ativo. |
| rights[group_id] | int|null | ID do grupo do usuário. |
| rights[role_id] | int|null | ID da função do usuário. |
| rights[status_rights] | array | Um array de objetos que definem direitos de estágios. |
| rights[status_rights][0] | object | Um objeto de direitos de estágio. |
| rights[status_rights][0][entity_type] | string | Tipo de entidade (atualmente, apenas lead é suportado). |
| rights[status_rights][0][pipeline_id] | int | ID do pipeline onde o estágio está localizado. |
| rights[status_rights][0][status_id] | int | ID do estágio. |
| rights[status_rights][0][rights] | object | Objeto de direitos. |
| _embedded[users] | array | Um array contendo os IDs dos usuários com a função atual. |
Responses