v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Pessoas

Retorna os dados bancários 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 bancários das pessoas a partir dos filtros solicitados.

get/pessoas/bancarios

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 bancários 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",
      "banco": "Banco Bankpar S.A.",
      "banco_nome": "Banco Bankpar S.A.",
      "banco_agencia": "1212",
      "banco_conta": "121",
      "banco_nome_titular": "Manoel Silva",
      "banco_tipo_doc": "CPF",
      "banco_cpf_titular": "77064304058",
      "banco_chave_pix": "1213112",
      "banco_observacoes": "Conta ativa desde 2011"
    }
  ]
}