Retornar a pessoa por id

Request

Permite consultar os detalhes de uma pessoa específica pelo seu identificador (id). A resposta inclui campos completos como nome, tipo de pessoa, documentos, perfis, contatos, endereços e demais informações pertinentes ao cadastro.

Security

BearerAuth

Path

idstringrequired

id da pessoa

curl -i -X GET \
  'https://api-v2.contaazul.com/v1/pessoas/{id}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

ativoboolean

Ativo

Example:true

atrasos_pagamentosnumber

Atrasos nos pagamentos

Example:750.25

atrasos_recebimentosnumber

Atrasos nos recebimentos

Example:1500.5

codigostring

Código da pessoa

Example:"CLI001"

contato_cobranca_faturamentoobject(ContatoCobrancaFaturamento)

Contato para cobrança e faturamento

criado_emstring, (date)

Data de criação da pessoa (ISO 8601, São Paulo/GMT-3)

Example:"2024-01-15"

data_alteracaostring, (date-time)

Data de alteração da pessoa (ISO 8601, São Paulo/GMT-3)

Example:"2024-01-15T10:30:00"

data_nascimentostring

Data de nascimento

Example:"1990-01-01"

documentostring

Documento da pessoa

Example:"123.456.789-00"

emailstring

Emails da pessoa separados por vírgula

Example:"joao.silva@email.com, maria.silva@email.com"

enderecosArray of objects(EnderecoPessoa)

Endereços da pessoa

idstring

ID da pessoa

Example:"550e8400-e29b-41d4-a716-446655440000"

inscricoesArray of objects(InformacoesFiscais)

Informações fiscais

lembretes_vencimentoArray of objects(LembretesVencimento)

Lembretes de vencimento

mensagem_pagamentos_abertosobject(MensagensPagamentosAbertos)

Mensagens de pagamentos em aberto

nomestring

Nome da pessoa

Example:"João Silva"

nome_empresastring

Nome da empresa

Example:"Empresa LTDA"

observacaostring

Observações gerais da pessoa

Example:"Observação geral"

optante_simples_nacionalboolean

Optante do Simples Nacional

Example:true

orgao_publicoboolean

Órgão público

Example:true

outros_contatosArray of objects(OutrosContatos)

Outros contatos

pagamentos_mes_atualnumber

Pagamentos do mês atual

Example:2500

perfisArray of objects(TipoPerfil)

Perfis da pessoa

pessoas_legadoArray of objects(PessoaLegada)

Pessoas legadas

recebimentos_mes_atualnumber

Recebimentos do mês atual

Example:5000

rgstring

Registro Geral (RG) da pessoa. Para pessoas estrangeiras, este campo representa o identificador estrangeiro.

Example:"12.345.678-9"

telefone_celularstring

Celular da pessoa

Example:"(11) 98765-4321"

telefone_comercialstring

Telefone comercial da pessoa

Example:"(11) 1234-5678"

tipo_pessoastring

Tipo de pessoa

Example:"FISICA"

Response

{
  "ativo": true,
  "atrasos_pagamentos": 750.25,
  "atrasos_recebimentos": 1500.5,
  "codigo": "CLI001",
  "contato_cobranca_faturamento": {
    "emails": [ … ],
    "whatsapp": "5511999999999"
  },
  "criado_em": "2024-01-15",
  "data_alteracao": "2024-01-15T10:30:00",
  "data_nascimento": "1990-01-01",
  "documento": "123.456.789-00",
  "email": "joao.silva@email.com, maria.silva@email.com",
  "enderecos": [
    { … }
  ],
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "inscricoes": [
    { … }
  ],
  "lembretes_vencimento": [
    { … }
  ],
  "mensagem_pagamentos_abertos": {
    "numero": 10,
    "total": 10
  },
  "nome": "João Silva",
  "nome_empresa": "Empresa LTDA",
  "observacao": "Observação geral",
  "optante_simples_nacional": true,
  "orgao_publico": true,
  "outros_contatos": [
    { … }
  ],
  "pagamentos_mes_atual": 2500,
  "perfis": [
    { … }
  ],
  "pessoas_legado": [
    { … }
  ],
  "recebimentos_mes_atual": 5000,
  "rg": "12.345.678-9",
  "telefone_celular": "(11) 98765-4321",
  "telefone_comercial": "(11) 1234-5678",
  "tipo_pessoa": "FISICA"
}