GET /v1/address/cep/{cep}
GET
/v1/address/cep/{cep}
const url = 'https://seu-endereco-da-api/v1/address/cep/example';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://seu-endereco-da-api/v1/address/cep/example \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Ler contatos (contacts:read), ou Gerenciar a Central de apps (integrations:manage).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”cep
required
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
cep
required
Os oito digitos, sem tracos
string
street
required
Vazio quando o CEP cobre a cidade inteira
string
neighborhood
required
Vazio quando os Correios nao tem o bairro dessa faixa
string
city
required
string
state
required
A sigla de duas letras
string
Example generated
{ "cep": "example", "street": "example", "neighborhood": "example", "city": "example", "state": "example"}Cep malformado ou desconhecido
A consulta de cep nao respondeu