v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Correspondentes

Retorna as empresas 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)

Esta API é responsável por retornar as empresas correspondentes cadastradas no CV.

get/v2/cadastros/correspondentes-empresas

Query parameters

paginainteger

Example:1

Página que deseja visualizar os registros.

registros_por_paginainteger

Example:30

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

Headers

emailstring required

Example:email@email.com

tokenstring required

Example:79d965e5027b7423423f2471824e799949c75f9ce

Response

paginainteger

Página

registrosinteger

Registros

total_de_registrosinteger

Total de registros

total_de_paginasinteger

Total de páginas

statusstring

Status da requisição

Example response

{
  "pagina": 1,
  "registros": 10,
  "total_de_registros": 100,
  "total_de_paginas": 10,
  "dados": [
    {
      "referencia": 193,
      "referencia_data": "2023-01-15 15:26:15",
      "idempresa": 193,
      "nome": "João da Silva",
      "regiao": "Nordeste",
      "telefone": "(79) 9999-9999",
      "estado": "SE",
      "cidade": "Aracaju",
      "email": "email@servidor.com.br",
      "dias_agendamento": 3,
      "data_cad": "2023-01-15 15:26:15"
    }
  ],
  "status": "success"
}