Pessoas

Clientes e contatos cadastrados na sua conta: proprietários, inquilinos, fiadores e demais pessoas físicas ou jurídicas.

Listar pessoas

GET /pessoas

Retorna uma lista paginada de pessoas, com suporte a filtros.

ParâmetroTipoDescrição
nomestringFiltra por nome
tipoPessoastringF (física) ou J (jurídica)
documentostringFiltra por CPF/CNPJ
statusinteger1 (ativo) ou 0 (inativo)
emailstringFiltra por e-mail
dataNascimento[min] / [max]dateIntervalo de nascimento (Y-m-d)
curl "https://api-aberta-prod.useimobia.com.br/api/v1/pessoas?tipoPessoa=F&status=1" \
  -H "API-KEY: SUA_CHAVE_AQUI"

Detalhes da pessoa

GET /pessoas/{id}

Retorna os dados detalhados de uma pessoa a partir do seu ID público encriptado.

Exemplo de resposta:

{
  "data": {
    "id": "4Y94M...",
    "codigo": "1234",
    "nome": "Gerente 1",
    "dataNascimento": "2000-12-05",
    "emailPrincipal": "[email protected]",
    "emailSecundario": "[email protected]",
    "celular": "5547999666332",
    "telefonePrincipal": "554700000000",
    "telefoneSecundario": "554700000000",
    "status": true,
    "tipoPessoa": "F",
    "documento": "97931509048",
    "cep": "88351001",
    "rua": "Rua Felipe Schmidt",
    "numero": "265",
    "complemento": "Apto 101",
    "bairro": "São Luiz",
    "cidade": "Brusque",
    "uf": "SC",
    "companhia": "Empresa teste",
    "profissao": "Testador"
  }
}
📘

Telefones e celular vêm sem formatação, como dígitos corridos com DDI 55 + DDD (ex.: 5547999666332). O documento (CPF/CNPJ) também vem sem formatação.

💡

Dica: os campos pessoaId retornados em Locações, Imóveis e Contas resolvem aqui — use GET /pessoas/{id} para converter qualquer participante em nome, documento e contatos.



Did this page help you?