CONTAGEM E SOLICITAÇÃO JOB

post

https://api.datastone.com.br/v1/company/prospect/

Este endpoint permite solicitar uma prospecção detalhada de empresas. Ele realiza duas funções:

Contagem: Se export for false, retorna o número total de registros encontrados (empresas e sócios) com base nos filtros aplicados.

Prospecção: Se export for true, inicia um job que coleta dados detalhados das empresas, incluindo os contatos dos sócios, se disponíveis. Esses detalhes adicionais são úteis para análises e para a tomada de decisão.

Nota: Ao enviar uma localização preenchida (cities ou states) a outra deverá ser vazia.

Body Params

name

string

required

Nome da prospecção

cities

array of strings

Defaults to []

Lista de cidades para filtrar os resultados. Cada item deve seguir o formato “Cidade - UF”, onde “UF” é a sigla do estado.

cities

states

array of strings

Defaults to []

Lista de siglas dos estados para filtrar os resultados.

states

contact_channels

array of strings

required

Defaults to []

Lista de canais de contato desejados para filtrar os resultados. Os valores válidos são: whatsapp (celular com whatsapp ativo do sócios) sms (celular) phone (celular ou fixo) email address

contact_channels*

export

boolean

required

Defaults to false

Indica se o endpoint deve apenas retornar a contagem ou iniciar o job de prospecção. Se export for true e o parâmetro quantity for informado, inicia o job de prospecção. Se export for false, retorna apenas a quantidade total (count) conforme os filtros.

plan

integer

required

Defaults to 3

Define o tipo de plano a ser aplicado na prospecção. Utilize 1 para o plano simples. Utilize 3 para o plano premium.

headquarter_type

string

Indica se a empresa é uma matriz ou uma filial. Os valores possíveis são: H: Matriz B: Filial

estimated_employees

object

Array de Objeto. Faixa estimada de quantidade de funcionários. ex.: [{"lower": 10, "upper": 1000}].

estimated_created

object

Array de Objeto. Faixa de data de criação da empresa. ex.: [{"lower": "1995-28-01", "upper": "2025-03-28"}].

cnae_codes

array of strings

Lista de códigos CNAE (Classificação Nacional de Atividades Econômicas) que descrevem as atividades exercidas pela empresa.

cnae_codes

revenues

object

Array de Objeto. Faixa de receita bruta da empresa. Ex.:[{"lower": "5000.00", "upper": "100000.00"}]

company_type

string

Tipo de empresa Os valores possíveis são: ME, EPP, DEMAIS.

nature_codes

array of strings

Lista de códigos que representam a natureza jurídica da empresa (por exemplo, 2135, 2062 etc.).

nature_codes

mei_type

string

Indica se a empresa é MEI (Microempreendedor Individual) ou não. (por exemplo, SIM ou NAO)

sector_codes

array of strings

Lista de códigos de setor ou segmento de mercado em que a empresa atua.

sector_codes

simple_type

string

Indica se a empresa faz parte do Simples Nacional. Os valores possíveis são: SIM ou NAO

capitals

object

Array de Objeto. Faixa do capital social da empresa. ex.:[{"lower": "5000.00", "upper": "100000.00"}]

import_export

string

Indica se a empresa atua com importação e/ou exportação. Os valores possíveis são: "IMPORTA" ou "EXPORTA".

vehicles

object

Array de Objeto. Indica a presença ou tipo de veículos associados à empresa. [{"lower": "5", "upper": "1000" }]

file_formatting

string

Defaults to excel

Define o formato de saída do arquivo gerado pela prospecção. Os valores possíveis são: "excel" ou "csv".

Headers

Authorization

string

Defaults to Token <seu_token>

Note: Envie o token no formato Token <seu_token> no cabeçalho Authorization.

Responses

200

400Bad Request