v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Pessoas

Retorna os dados patrimoniais das pessoas

🔒 Autenticação necessária

Esta API utiliza autenticação via e-mail e token nos headers da requisição. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Esta api retorna os valores dos dados patrimoniais das pessoas a partir dos filtros solicitados.

get/pessoas/patrimoniais

Query parameters

paginainteger

Página que deseja visualizar os registros

registros_por_paginainteger

Quantidade de registro por página, máximo 500 registros

a_partir_referenciainteger

Retornará os registros a partir deste id, lembrando que está ordenado por referencia_data.

a_partir_data_referenciastring

Retornará os registros com data referência a partir da data informada

ate_data_referenciastring

Retornará os registros com data referência até a data informada

Headers

emailstring required

E-mail de autenticação do usuário administrativo

tokenstring required

Token criado no usuário administrativo do e-mail

Response

Corpo de resposta dos dados patrimoniais das pessoas

paginainteger

Página atual do retorno dos registros

registrosinteger

Quantidade de registro da página, máximo 500 registros

total_de_registrosinteger

Total de registros encontrados

total_de_paginasinteger

Total de páginas encontradas

Example response

{
  "pagina": 1,
  "registros": 30,
  "total_de_registros": 1054,
  "total_de_paginas": 36,
  "dados": [
    {
      "referencia": "193 ou 193_30",
      "referencia_data": "2023-12-29 16:12:52",
      "ativo": "S",
      "idpessoa": 269,
      "idpessoa_int": "726",
      "possui_bem": "S",
      "quantidade_imoveis_possui": 1,
      "quais_bens": "Descrição dos bens que possui",
      "situacao_do_bem": "Quitado",
      "valor_do_bem": "16151.15",
      "novos_bens": {
        "idpessoa_novo_bem": 5,
        "data_cad": "2020-09-30 17:55:19",
        "tipo_novo_bem": "Imóveis",
        "cep_novo_bem": "49037550",
        "endereco_novo_bem": "Avenida Rotary",
        "bairro_novo_bem": "Atalaia",
        "estado": "Sergipe",
        "cidade": "Aracaju"
      }
    }
  ]
}