get
https://{subdominio}.kommo.com/api/v4/companies
Este método te permite obtener una lista de compañías.
Limitaciones
El método está disponible de acuerdo con los permisos del usuario.
Parámetros “with”
| Parámetro | Descripción |
|---|---|
| leads | Añade información sobre los leads vinculados al contacto en la respuesta. |
| contacts | Añade información sobre los contactos vinculados a la compañía en la respuesta. |
| catalog_elements | Añade los elementos de las listas vinculados al contacto en la respuesta. |
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
Las propiedades de un objeto compañía se enumeran a continuación.
| Parámetro | Tipo de dato | Descripción |
|---|---|---|
| id | int | ID de la compañía. |
| name | string | Nombre de la compañía. |
| responsible_user_id | int | ID del usuario responsable de la compañía. |
| group_id | int | ID de grupo del usuario responsable de la compañía. |
| created_by | int | El ID del usuario que creó la compañía. |
| updated_by | int | El ID del usuario que actualizó la compañía por última vez. |
| created_at | int | Fecha de creación de la compañía en formato Unix Timestamp. |
| updated_at | int | Fecha de actualización de la compañía en formato Unix Timestamp. |
| closest_task_at | int | Fecha de la tarea abierta más cercana en formato Unix Timestamp. |
| custom_fields_values | array|null | Un arreglo de los valores actuales de los campos personalizados de la compañía. |
| account_id | int | ID de la cuenta en la que se encuentra la compañía. |
| object | Datos de entidades asociadas. |
| array | Arreglo de datos de etiquetas de la compañía contacto. |
| object | Modelo de etiqueta de la compañía. |
| int | ID de la compañía. |
| string | Nombre de la compañía. |
| string/null | Color de la compañía. |
| array | El parámetro GET “with” es obligatorio. Arreglo de datos de contactos asociado. |
| object | Datos de los contactos asociados. |
| int | Id del contacto asociado. |
| array | El parámetro GET “with” es obligatorio. Arreglo de datos de leads asociados. |
| object | Datos de los leads asociados. |
| int | ID del lead asociado. |
| array | El parámetro GET “with” es obligatorio. Arreglo de datos de los elementos de las listas asociadas. |
| object | Datos del elemento de la lista asociada. |
| int | ID del elemento asociado. |
| object | Metadatos del elemento. |
| int | Cantidad de elementos asociados. |
| int | ID de la lista del elemento asociado. |