v1
latestOpenAPI 3.0.02026-07-264636241.7 MBRetorna os dados 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 das pessoas a partir dos filtros solicitados, caso deseje saber o que cada campo representa basta ir no schema.
Query parameters
Página que deseja visualizar os registros
Quantidade de registro por página, máximo 500 registros
Retornará os registros a partir deste id, lembrando que está ordenado por referencia_data.
Retornará os registros com data referência a partir da data informada
Retornará os registros com data referência até a data informada
Headers
E-mail de autenticação do usuário administrativo
Token criado no usuário administrativo do e-mail
Response
Corpo de resposta dos dados das pessoas
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": 1,
"idpessoa_int": "1",
"idpessoa_legado": 1,
"data_cad": "2017-12-18 15:20:45",
"ativo_painel": "Sim",
"ativo_login": "Sim",
"situacao": "Cliente",
"validado": "Sim",
"documento_tipo": "CPF",
"documento": "111.111.111-11",
"pessoa_estrangeira": "Não",
"nome": "Associado Silva Santos",
"sexo": "Masculino",
"data_nasc": "1985-05-12",
"estado_civil": "Casado(a) - Participação final nos aquestos",
"data_casamento": "2023-03-01",
"pacto_antenupcial_livro": "Informação do Pacto antenupcial",
"folha": "12",
"cartorio": "Cartório",
"pais": "Brasil",
"naturalidade": "Aracaju",
"possui_dependentes": "Sim",
"quantidade_dependentes": 1,
"possui_procuracao": "Sim",
"possui_pacto_antenupcial": "Não",
"menor_nao_emancipado": "Sim",
"grau_instrucao": "Ensino médio incompleto",
"renda_familiar": "5000.00",
"marketing_pos_venda": "Sim",
"rg": "25465-1",
"rg_orgao_emissor": "ssp-SE",
"rg_data_emissao": "1984-12-12",
"rne": "25465-1",
"rne_orgao_emissor": "PF",
"rne_data_emissao": "2012-05-25",
"passaporte": "CS265436",
"passaporte_orgao_emissor": "PF",
"passaporte_data_emissao": "2023-05-25",
"cnh": "03662589788",
"cnh_orgao_emissor": "Detran",
"data_primeira_habilitacao_cnh": "2018-05-25",
"data_fim_validade_cnh": "2024-05-35",
"cnh_data_emissao": "2022-02-28",
"rnm": "A123456-7",
"rnm_orgao_emissor": "PF",
"rnm_data_emissao": "2022-02-28",
"filiacao_mae": "Nome da mãe",
"filiacao_pai": "Nome do pai",
"razao_social": "Empresa Nome LTDA",
"segmento_razao": "Cosméticos",
"razao_social_anterior": "Empresa Nome Família LTDA",
"sucessao": "Sim",
"forma_constituicao": "LTDA",
"data_constituicao": "2023-11-13",
"numero_junta_comercial": "178",
"classificacao": "Pessoa",
"insc_estadual": "34853689-5",
"insc_municipal": "985.308.573.887",
"cep": "49030210",
"logradouro": "Avenida",
"endereco": "Pastora Maria",
"bairro": "Farolândia",
"numero": "3232",
"complemento": "Apartamento 708",
"estado": "SE",
"cidade": "Aracaju",
"endereco_pais": "Brasil",
"tipo_residencia": "Própria com financiamento",
"reside_com": "Com os pais",
"valor_aluguel": "1750.00",
"tempo_residencia": 1,
"tipo_correspondencia": "Residencial",
"politicamente_exposta": "Não",
"ppe_exercicio": "2001-2004",
"suspeito": "Não",
"residente_municipio_fronteira": "Não",
"relacionamento_ppe": "Não",
"relacionamento_ppe_nome": "João Gomes",
"relacionamento_ppe_parentesco": "Irmão",
"relacionamento_ppe_cargo": "Analista",
"relacionamento_ppe_exercicio": "2001-",
"relacionamento_ppe_identificacao": "12544-85",
"relacionamento_ppe_orgao_emissor": "SSP",
"relacionamento_ppe_data_nasc": "2011-05-28",
"relacionamento_ppe_cpf": "111.111.111-11",
"numero_pis": "21212",
"observacoes": "Observações"
}
]
}