Lista de Empresas

Limitações
O método está disponível de acordo com os direitos do usuário.

Parâmetros “with”

Parâmetro	Descrição
leads	Adds info on the leads linked to the company into the response
contacts	Adds info on the contacts linked to the company into the response
catalog_elements	Adds lists elements linked to the company into the response

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 de resposta

The properties of a company object are listed below.

Parâmetro	Tipo de dado	Descrição
id	int	ID da Empresa
name	string	Nome da Empresa
responsible_user_id	int	ID do usuário responsável pela empresa
group_id	int	ID do grupo do usuário responsável pela empresa
created_by	int	ID do usuário que criou a empresa
updated_by	int	ID do usuário que atualizou a empresa por último
created_at	int	Data de criação da empresa no formato de Unix Timestamp
updated_at	int	Data de atualização da empresa no formato de Unix Timestamp
closest_task_at	int	Data da tarefa aberta mais próxima no formato de Unix Timestamp
custom_fields_values	array\|null	Um array dos valores dos campos personalizados atuais da empresa
account_id	int	ID da conta onde a empresa está localizada
embedded	object	Dados das entidades incorporadas
embedded[tags]	array	Array de dados das tags da empresa
embedded[tags][0]	object	Modelo de tag da empresa
embedded[tags][0][id]	int	ID da Tag
embedded[tags][0][name]	string	Nome da Tag
embedded[tags][0][color]	string/null	Cor da Tag
embedded[contacts]	array	O parâmetro GET “with” é obrigatório Array de dados dos contatos vinculados
embedded[contacts][0]	object	Dados do contato vinculado
embedded[contacts][0][id]	int	ID do contato vinculado
embedded[leads]	array	O parâmetro GET “with” é obrigatório Array de dados dos leads vinculados
embedded[leads][0]	object	Dados do lead vinculado
embedded[leads][0][id]	int	ID do lead vinculado
embedded[catalog_elements][catalog_elements]	array	O parâmetro GET “with” é obrigatório Array de dados dos elementos de listas vinculadas
embedded[catalog_elements][0]	object	Dados do elemento da lista vinculada
embedded[catalog_elements][0][id]	int	ID do elemento vinculado
embedded[catalog_elements][0][metadata]	object	Metadados do elemento
embedded[catalog_elements][0][quantity]	int	Quantidade de elementos vinculados
embedded[catalog_elements][0][catalog_id][catalog_id]	int	ID da lista do elemento vinculado