get https://{subdominio}.kommo.com/api/v4/users
Este método permite obtener los datos del usuario en la cuenta mediante el ID del usuario.
Limitaciones
El método está disponible solo para usuarios administradores.
Encabezado de tipo de datos cuando la solicitud es exitosa
Content-Type: application/hal+json.
Encabezado de tipo de datos en caso de un error
Content-Type: application/problem+json.
Parámetros para los parámetros GET "with"
| Parámetro | Descripción |
|---|---|
| role | Añade el rol del usuario en la respuesta. |
| group | Añade el grupo del usuario en la respuesta. |
| uuid | Añade el UUID del usuario en la respuesta, puede ser nulo, actualmente el UUID no se utiliza para integraciones de terceros. |
| amojo_id | Añade el ID del usuario en el servicio de chat a la respuesta, puede ser nulo. |
| user_rank | Añade el rango del usuario a la respuesta. Opciones posibles: principiante/candidato/maestro. |
Parámetros de respuesta
El método retorna un objeto usuario. Las propiedades del objeto se enumeran a continuación.
Los objetos de derechos tienen una estructura común. Dependiendo del tipo de entidad, estos objetos contienen acciones disponibles como claves y los derechos para la acción como valor. Por ejemplo, rights[leads][view]=A.
| Parámetro | Tipo de dato | Descripción |
|---|---|---|
| id | int | ID del usuario. |
| name | string | Nombre completo del usuario. |
| string | Correo del usuario. | |
| lang | string | Idioma del usuario. Uno de los siguientes: en, es, pt. |
| rights | object | Permisos del usuario. |
| rights[leads] | object | Objeto de permisos de acceso a los leads. |
| rights[contacts] | object | Objeto de permisos de acceso a los contactos. |
| rights[companies] | object | Objeto de permisos de acceso a compañías. |
| rights[tasks] | object | Objeto de permisos de acceso a tareas. |
| rights[mail_access] | bool | Define si la funcionalidad de Correo está permitida para el usuario. |
| rights[catalog_access] | bool | Define si la funcionalidad de Listas está permitida para el usuario. |
| rights[is_admin] | bool | Define si el usuario tiene derechos de administrador. |
| rights[is_free] | bool | Define si es un usuario gratuito. |
| rights[is_active] | bool | Define si el usuario se encuentra activo. |
| rights[group_id] | int|null | ID del grupo del usuario. |
| rights[role_id] | int|null | ID del rol del usuario. |
| rights[status_rights] | array | Un arreglo de objetos que define los permisos de las etapas. |
| rights[status_rights][0] | object | Un objeto de derechos de etapa. |
| rights[status_rights][0][entity_type] | string | Tipo de entidad. Actualmente, solo se admite la entidad de lead. |
| rights[status_rights][0][pipeline_id] | int | ID del pipeline en el que se encuentra la etapa. |
| rights[status_rights][0][status_id] | int | ID de la etapa. |
| rights[status_rights][0][rights] | object | Objeto de derechos. |