Pular para o conteúdo
notemnotemDocumentação

Referência da API › Empresas

Listar empresas

Lista as empresas emitentes da organização, da mais recente para a mais antiga.

GET/api/v1/empresas

Use para encontrar o ID de uma empresa ou conferir quais estão ativas. A lista é paginada e aceita filtros que podem ser combinados, como CNPJ, empresa ativa ou inativa e busca pelo nome.

Parâmetros

limiteinteirona consulta
de 1 a 100 · Padrão: 50
cursortextona consulta
cnpjtextona consulta
até 18 caracteres
id_externotextona consulta
até 100 caracteres
ativabooleanona consulta
buscatextona consulta
Razão social ou nome fantasia (2+ caracteres) · mínimo de 2 caracteres

Respostas

200 Lista paginada

Campos da resposta
dadoslista de objeto
dados[].idtexto
UUID
dados[].id_externotexto ou null
até 100 caracteres
dados[].cnpjtexto
CNPJ de 14 posições, numérico ou alfanumérico (12 posições 0-9/A-Z + 2 dígitos verificadores). Na entrada, máscara e minúsculas são aceitas e normalizadas; nas respostas vem sempre com 14 caracteres maiúsculos, sem máscara. · até 18 caracteres
dados[].razao_socialtexto
dados[].nome_fantasiatexto ou null
dados[].inscricao_municipaltexto ou null
dados[].emailtexto ou null
dados[].telefonetexto ou null
dados[].enderecoobjeto
dados[].endereco.ceptexto ou null
dados[].endereco.logradourotexto ou null
dados[].endereco.numerotexto ou null
dados[].endereco.complementotexto ou null
dados[].endereco.bairrotexto ou null
dados[].endereco.codigo_municipiotexto
Formato: ^\d{7}$
dados[].endereco.municipiotexto ou null
dados[].endereco.uftexto ou null
dados[].ativabooleano
dados[].criada_emtexto
data e hora ISO 8601
dados[].atualizada_emtexto
data e hora ISO 8601
proximo_cursortexto ou null

400 Erro no formato padrão

401 Chave ausente, inválida ou revogada

Limites

Esta operação: 60 por minuto. Valem também os limites gerais da chave. Veja Limites de uso.