CVcvcrm
Pessoa

Retornar os dados de uma pessoa pelo seu documento

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization, gerado pelo endpoint de autenticação do próprio Portal do Cliente: POST /api/v1/cliente/autenticacao (documento e senha do cliente) ou POST /api/v1/cliente/autenticacao/sindico (síndicos). ⚠️ O token de integração das APIs v2/v3 (POST /api/v3/auth/token) não é válido para o Portal do Cliente: ele não representa um cliente e as consultas retornarão vazias ou dados incorretos.

get/pessoa/{documento}

Request

  • Base URL
    https://integracao.cvcrm.com.br/api/v1/cliente
  • URL
    https://integracao.cvcrm.com.br/api/v1/cliente/pessoa/{documento}
  • Auth
    HTTP bearer

Path parameters

documentostring required

número do documento do cliente

Response

Dados da pessoa

idpessoainteger
nomestring
emailstring
telefonestring
celularstring
codigointernostring
situacaostring
idunidade_padraointeger

Example response

{
  "idpessoa": 12,
  "nome": "Nome pessoa",
  "email": "mai*****@****.com",
  "telefone": "(79) 3245-****",
  "celular": "(79) 93246-****",
  "codigointerno": "15646",
  "situacao": "C",
  "idunidade_padrao": 16108
}

Changes

No recorded changes to this operation across all 1 revision of this API.