Skip to main content
GET
Consultar empresa

Autorizações

Authorization
string
header
obrigatório

OAuth2 Authorization Code flow

Parâmetros de caminho

idOrDocument
string
obrigatório

Company ID (cmp_*) or document (CNPJ)

Resposta

Company found

object
string
obrigatório

Object type

Exemplo:

"page"

id
string
obrigatório

Unique identifier

Exemplo:

"p_abc123"

createdAt
string<date-time>
obrigatório

Creation timestamp

Exemplo:

"2024-01-15T10:30:00.000Z"

updatedAt
string<date-time>
obrigatório

Last update timestamp

Exemplo:

"2024-01-15T14:45:00.000Z"

document
string
obrigatório
Exemplo:

"00000000000191"

archived
boolean
padrão:false
obrigatório
createdBy
Created by · object

Principal who created this object

Exemplo:
updatedBy
Updated by · object

Principal who last updated this object

Exemplo:
tradeName
string
icon
Icon · object | null
archivedAt
string
archivedBy
string
addressState
string
addressType
string
addressStreet
string
addressNumber
string
addressComplement
string
addressNeighborhood
string
addressZipCode
string
addressCity
string
registrationStatus
string
registrationStatusDate
string | null
email
string | null
phones
string[] | null
companySize
string | null
capital
string | null
simplesOption
boolean | null
simplesOptionDate
string | null
meiOption
boolean | null
meiOptionDate
string | null
mainCnae
Main CNAE · object
secondaryCnaes
Secondary CNAEs · object[]
isHeadquarter
boolean
activityStartDate
string | null