Empresas Brasileiras

CNPJs elegíveis

Lista paginada por keyset (after_cnpj) dos CNPJs da coorte firmográfica. As quatro chaves filter, count, next_cursor e data estão sempre presentes. data é um array de CNPJs (14 posições). next_cursor é o último CNPJ quando a página enche, senão null. filter ecoa require_matriz, portes, capital_social_min e n_filiais_min; situacoes só entra quando o cliente envia.

Autenticação: Authorization: Bearer <token_digest> (preferida) ou query api_token (legado). Recusas 401/403/429/503 usam o JSON literal do controller e dos concerns.

Disponível conforme o plano (api_search_enabled). Cada chamada conta 1 na quota mensal. Limite de 30 chamadas por minuto por conta neste grupo de endpoints; eligible devolve até 1.000 CNPJs por página.

get/api/v1/brazilian_companies/eligible

Request

  • Base URL: https://app.oportunidados.com.br
  • URL: https://app.oportunidados.com.br/api/v1/brazilian_companies/eligible
  • Auth: one of:
    • HTTP bearer
    • API key in query parameter api_token

Query parameters

api_tokenstring

Digest do ApiToken (legado). Prefira Authorization: Bearer.

require_matrizboolean

Default true

portesstring

CSV. Default: Empresa de Médio e Grande Porte

situacoesstring

CSV de situacao_cadastral. Sem default; omitido no filter se ausente

capital_social_mininteger

Default 1000000

n_filiais_mininteger

Default 1

after_cnpjstring

Cursor keyset (cnpj > after_cnpj)

limitinteger

Default e teto: Api::V1::SearchLimits.eligible_max_limit (env API_ELIGIBLE_MAX_LIMIT, padrão 1.000). Valor não-positivo volta ao default.

Response

sucesso

countinteger required
next_cursorstring nullable required
datastring[] required

Changes

No recorded changes to this operation across all 1 revision of this API.