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

Request

Base URL
https://integracao.cvcrm.com.br/api
URL
https://integracao.cvcrm.com.br/api/v2/cadastros/correspondentes-empresas
Auth
none declared. Required headers: email, token

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

E-mail de autenticação no Construtor de Vendas.

tokenstring required

Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação no Construtor de Vendas.

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": [
    {
      "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",
      "usuarios": [
        {
          "idusuario": 193,
          "idempresa": 3,
          "nome": "João da Silva",
          "documento": 12345678910,
          "departamento": "Financeiro",
          "funcao": "Gerente",
          "telefone": "(79) 9999-9999",
          "celular": "(79) 9999-9999",
          "estado": "Sergipe",
          "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"
        }
      ],
      "workflow": {
        "repasse": [
          {
            "valor": 2,
            "label": "Reservado"
          }
        ],
        "reserva": [
          {
            "valor": 2,
            "label": "Reservado"
          }
        ],
        "pre_cadastro": [
          {
            "valor": 2,
            "label": "Reservado"
          }
        ]
      },
      "agencias": [
        {
          "idagencia": 12,
          "nome": "Agência Centro",
          "banco": "Caixa Econômica Federal"
        }
      ]
    }
  ],
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.