v1

latestOpenAPI 3.1.02026-07-242200814.7 KB

Listar empresas

get/companies

Query parameters

showinteger

Número de itens na página de resultado.

cursorstring

Hash da próxima página.

withstring

Obter recursos com relações. Opções:personsRelated.person ,personsRelated,deals_involved,activities,emails,contactEmails,'contactPhones

city_idinteger

Filtrar pelo ID da cidade da empresa.

manager_idinteger

Filtrar pelo ID do usuário CS responsável pela empresa.

segment_idinteger

Filtrar pelo ID do segmento de negócio da empresa.

namestring

Filtrar pelo nome da empresa.

starts_withstring

Filtrar pelo início do nome da empresa.

cnpjstring

Filtrar pelo CNPJ da empresa. Formatos aceitos: "XXXXXXXX0001XX" e "XX.XXX.XXX/0001-XX".

observationstring

Filtrar pelas observações sobre a empresa.

websitestring

Filtrar pelo website da empresa.

company_statusboolean

Filtrar pelo status ativo/inativo do registro da empresa.

company_situationinteger

Filtrar pela situação da empresa: 1: lead, 2: lead suspect, 3: lead qualificado de marketing (MQL), 4: lead qualificado de vendas (SQL), 5: lead aceito por vendas (SAL), 6: lead prospects (OPs), 7: cliente ativo, 8: cliente inativo, 9: cliente perdido.

status_touchinteger

Filtrar pelo modelo touch da empresa: 1: high touch, 2: middle touch, 3: low touch, 4: tech touch, 5: now touch.

is_brandboolean

Filtrar pelo tipo de empresa: marca.

is_supplierboolean

Filtrar pelo tipo de empresa: fornecedor.

is_clientboolean

Filtrar pelo tipo de empresa: cliente.

is_carrierboolean

Filtrar pelo tipo de empresa: transportadora.

is_franchiseboolean

Filtrar pelo tipo de empresa: franquia.

is_channelboolean

Filtrar pelo tipo de empresa: canal de venda.

statusboolean

Filtrar pela situação cadastral ativo/inativo da empresa.

external_codestring

Filtrar pelo código externo da empresa.

customer_at_startstring date

Filtrar por registros de empresas que viraram clientes a partir da data e hora informada.

customer_at_endstring date

Filtrar por registros de empresas que viraram clientes até data e hora informada.

created_at_startstring date

Filtrar por registros de empresas criadas a partir da data e hora informada.

created_at_endstring date

Filtrar por registros de empresas criadas até a datae hora informada.

updated_at_startstring date

Filtrar por registros de pessoas atualizadas a partir da data e hora informada.

updated_at_endstring date

Filtrar por registros de pessoas atualizadas até a data e hora informada.

Response

200