v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Pessoas

Retorna os dados de contatos 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 de contatos das pessoas a partir dos filtros solicitados.

get/pessoas/contatos

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 de contatos 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_int": "726",
      "idpessoa": 269,
      "email": "email@email.com",
      "telefone": "(25) 99988-7766",
      "ramal": 22,
      "celular": "(79) 99988-7766",
      "referencia_nome": "Contato Referência",
      "referencia_telefone": "+557999988-7766",
      "referencia_parentesco": "Amigo",
      "cep_contato_relacionamento": "49015120",
      "endereco_contato_relacionamento": "Rua Itabaiana",
      "bairro_contato_relacionamento": "São José",
      "numero_contato_relacionamento": "150",
      "complemento_contato_relacionamento": "ap 9191",
      "estado_contato_relacionamento": "SE",
      "cidade_contato_relacionamento": "Aracaju",
      "pais_contato_relacionamento": "Brasil",
      "telefone_contato_relacionamento": "+557984848484",
      "celular_contato_relacionamento": "+55978949448484",
      "email_contato_relacionamento": "email@email.com",
      "nome_representante_pj": "Manoel Gomes",
      "documento_representante_pj": "111.111.111-11",
      "cargo_pj": "Analista",
      "email_relacionamento_pj": "email@email.com",
      "telefone_relacionamento_pj": "+5579498489489",
      "genero_representante": "Masculino"
    }
  ]
}