v1

latestOpenAPI 3.1.02026-07-261620662.2 KB

Lista de Empresas

O método permite obter uma lista de empresas.

get/api/v4/companies

Query parameters

withstring

Este parâmetro aceita uma string que pode conter vários valores separados por vírgulas. Veja a tabela acima.

pageinteger

Página da resposta

limitinteger

O número de entidades retornadas na resposta de uma solicitação (limite – 250)

querystring

Consulta de pesquisa (realizará uma busca pelos valores dos campos personalizados)

order[updated_at]'asc' | 'desc'

Ordenação dos elementos da lista pelo horário em que as empresas foram atualizadas

order[id]'asc' | 'desc'

Ordenação dos elementos da lista

filter[id][]integer[]

Filtro pelo ID do usuário que adicionou a empresa

filter[name][]string[]

Filtrar por Nome da Empresa

filter[created_by][]integer[]

Filtro pelo ID do usuário que adicionou a empresa

filter[updated_by][]integer[]

Filtro pelo ID do usuário que atualizou a empresa por último

filter[responsible_user_id][]integer[]

Filtro pelo ID do usuário responsável pela empresa

filter[created_at][from]integer

Filtro pela data de criação da empresa no formato Unix Timestamp. Como resposta, você receberá todas as empresas adicionadas após essa data.

filter[created_at][to]integer

Filtro pela data de criação da empresa no formato Unix Timestamp. Como resposta, você receberá todas as empresas adicionadas antes dessa data.

filter[updated_at][from]integer

Filtro pela data em que a empresa foi atualizada no formato Unix Timestamp. Como resposta, você receberá todas as empresas atualizadas após essa data.

filter[updated_at][to]integer

Filtro pela data em que a empresa foi atualizada no formato Unix Timestamp. Como resposta, você receberá todas as empresas atualizadas antes dessa data.

filter[closest_task_at][from]integer

Filtro de leads pela data da tarefa mais próxima da conclusão no formato Unix Timestamp.

filter[closest_task_at][to]integer

Filtro de leads pela data da tarefa mais próxima da conclusão no formato Unix Timestamp.

Response

200