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.
embedded	object	Datos de entidades asociadas.
embedded[tags]	array	Arreglo de datos de etiquetas de la compañía contacto.
embedded[tags][0]	object	Modelo de etiqueta de la compañía.
embedded[tags][0][id]	int	ID de la compañía.
embedded[tags][0][name]	string	Nombre de la compañía.
embedded[tags][0][color]	string/null	Color de la compañía.
embedded[contacts]	array	El parámetro GET “with” es obligatorio. Arreglo de datos de contactos asociado.
embedded[contacts][0]	object	Datos de los contactos asociados.
embedded[contacts][0][id]	int	Id del contacto asociado.
embedded[leads]	array	El parámetro GET “with” es obligatorio. Arreglo de datos de leads asociados.
embedded[leads][0]	object	Datos de los leads asociados.
embedded[leads][0][id]	int	ID del lead asociado.
embedded[catalog_elements][catalog_elements]	array	El parámetro GET “with” es obligatorio. Arreglo de datos de los elementos de las listas asociadas.
embedded[catalog_elements][0]	object	Datos del elemento de la lista asociada.
embedded[catalog_elements][0][id]	int	ID del elemento asociado.
embedded[catalog_elements][0][metadata]	object	Metadatos del elemento.
embedded[catalog_elements][0][quantity]	int	Cantidad de elementos asociados.
embedded[catalog_elements][0][catalog_id][catalog_id]	int	ID de la lista del elemento asociado.