v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Correspondentes

Retorna os usuários correspondentes

🔒 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)

Lista os usuários correspondentes

get/correspondentes-usuarios

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

Respostas da pesquisa

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

statusstring

Status da requisição

Example response

{
  "pagina": 1,
  "registros": 30,
  "total_de_registros": 1054,
  "total_de_paginas": 36,
  "dados": [
    {
      "idusuario": 193,
      "referencia": 193,
      "idempresa": 3,
      "nome": "João da Silva",
      "documento": "12345678910",
      "departamento": "Financeiro",
      "funcao": "Gerente",
      "telefone": "(79) 9999-9999",
      "celular": "(79) 9999-9999",
      "estado": "SE",
      "cidade": "Aracaju",
      "email": "email@servidor.com.br",
      "gerente": true,
      "ativo_login": true,
      "data_nasc": "1987-12-03",
      "data_cad": "2023-01-15 15:26:15",
      "referencia_data": "2023-01-15 15:26:15"
    }
  ],
  "status": "success"
}