get
https://{subdominio}.kommo.com/api/v4/account
Este método permite obtener la información de la cuenta.
Limitaciones
El método está disponible para todos los usuarios de la cuenta.
Parámetros “with”
| Parámetro | Descripción |
|---|---|
| amojo_id | Añade el ID de la cuenta en el servicio de chat en línea a la respuesta. |
| amojo_rights | Añade en la respuesta información sobre la disponibilidad de la funcionalidad para crear grupos y utilizar chats directos por parte de los usuarios. |
| users_groups | Añade información sobre los grupos disponibles de usuarios de la cuenta a la respuesta. |
| task_types | Añade a la respuesta información sobre los tipos de tareas disponibles en la cuenta. |
| version | Añade a la respuesta información sobre la versión actual de Kommo. |
| entity_names | Añade los nombres de las entidades a la respuesta con sus traducciones y formas numéricas. |
| datetime_settings | Añade a la respuesta información sobre la configuración actual de los formatos de fecha y hora de la cuenta. |
| drive_url | Añade la dirección del servicio de archivos para la cuenta solicitada. |
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 de respuesta
| Parámetro | Tipo de dato | ¿Es requerido "with"? | Descripción |
|---|---|---|---|
| id | int | ❌ | ID del contacto. |
| name | string | ❌ | Nombre del contacto. |
| subdomain | string | ❌ | Subdominio de la cuenta. |
| current_user_id | int | ❌ | ID del usuario actual. |
| country | string | ❌ | País especificado en la configuración de la cuenta |
| currency | string | ❌ | Moneda especificada en la configuración de la cuenta. |
| currency_symbol | string | ❌ | Símbolo de la moneda. |
| is_unsorted_on | bool | ❌ | ¿Está habilitada la funcionalidad Leads entrantes? |
| is_loss_reason_enabled | bool | ❌ | ¿Está habilitada la funcionalidad de Motivo para leads cerrados-perdidos? |
| is_helpbot_enabled | bool | ❌ | ¿Está habilitada la funcionalidad Inicialización IA? (disponible solo en el plan de suscripción Empresarial). |
| is_technical_account | bool | ❌ | ¿Es la cuenta técnica? |
| contact_name_display_order | int | ❌ | Define el orden del nombre del contacto (1 – Primer Nombre, Apellido; 2 – Apellido, Primer Nombre). |
| amojo_id | string | ✅ | Identificador único de la cuenta en el servicio de chat en línea amojo. |
| version | int | ✅ | Versión actual de Kommo. |
| _embedded[amojo_rights] | obj | ✅ | Objeto de configuración de chats. |
| _embedded[can_direct] | obj | ✅ | Define si los chats internos están disponibles. |
| _embedded[can_create_groups] | obj | ✅ | Define si los chats grupales están disponibles. |
| _embedded[users_groups] | array | ✅ | Arreglo de los objetos de grupos de usuarios de Kommo. |
| _embedded[0][id] | int | ✅ | ID del grupo de usuarios. |
| _embedded[0][name] | string | ✅ | Nombre del grupo de usuarios. |
| _embedded[task_types] | array | ✅ | Tipos de tareas en la cuenta. |
| _embedded[0][id] | int | ✅ | ID del tipo de tarea. |
| _embedded[0][name] | string | ✅ | Nombre del tipo de tarea. |
| _embedded[0][color] | string | ✅ | Color del tipo de tarea. |
| _embedded[0][icon_id] | int | ✅ | ID del ícono del tipo de tarea. |
| _embedded[0][code] | string | ✅ | Código del tipo de tarea. |
| _embedded[datetime_settings] | obj | ✅ | Configuración y formato de fecha y hora en la cuenta. |
| _embedded[entity_names] | obj | ✅ | Configuración de los nombres de las entidades. |