v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Cliente

Retorna clientes.

🔒 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 serve como um informativo ao sistema legado acerca dos clientes cadastrados no Construtor de Vendas, neste caso do tipo “get”, o usuário não envia informações além da autenticação, a resposta são os dados buscados. A requisição retorna os dados de determinado cliente. É obrigatório o envio de pelo menos um dos campos como parâmetro na URL: Documento, Telefone ou E-mail do cliente.

get/v1/cadastros/clientes

Query parameters

documentostring

Example:64239558811

Documento do cliente (CNPJ ou CPF)

telefonestring

Example:79988888888

Telefone do cliente

emailstring

Example:joselino@email.com

E-mail do cliente

idclientenumber

Example:123456

ID do cliente

Headers

emailstring required

Example:email@email.com

E-mail de autenticação para consulta de clientes.

tokenstring required

Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para consulta de clientes.

Response

Cliente

codigostring

Example response

{
  "codigo": "200",
  "pessoas": [
    {
      "idpessoa_int": "15",
      "idpessoa": "25",
      "idpessoa_legado": "5487",
      "ativo": "S",
      "ativo_login": "S",
      "idpais": "33",
      "idcidade": "4733",
      "idestado": "26",
      "idlogradouro": "9",
      "data_cad": "2021-04-19 13:48:13",
      "sexo": "M",
      "data_nasc": "2018-01-06",
      "nome": "Joselino Augusto",
      "documento_tipo": "cpf",
      "documento": "64239558811",
      "rg": "35129640",
      "rg_orgao_emissor": "SSP-SE",
      "rg_data_emissao": "2010-05-03",
      "data_primeira_habilitacao_cnh": "2010-05-03",
      "data_fim_validade_cnh": "2010-05-03",
      "filiacao_mae": "Maria dos Santos",
      "filiacao_pai": "Pedro dos Santos",
      "cep": "49000000",
      "bairro": "Farolandia",
      "numero": "959",
      "endereco": "Av. Adel Nunes",
      "complemento": "Bloco H",
      "telefone": "79999999999",
      "profissao": "Analista",
      "email": "joselino@email.com",
      "celular": "79988888888",
      "renda_familiar": "750000",
      "observacoes": "Cliente divorciado a espera da certidão de divórcio, precisará alterar os dados futuramente",
      "estado_civil": "1",
      "data_casamento": "2018-08-11",
      "pais": "Brasil",
      "estado": "São Paulo",
      "cidade": "Itaquaquecetuba",
      "insc_estadual": "123.987.283.874",
      "insc_municipal": "657943-7",
      "valor_faturamento_mensal_pj": 50000,
      "valor_lucro_liquido_mensal_pj": 200000,
      "valor_contas_receber_pj": 14000,
      "valor_estoque_pj": 130000,
      "valor_instalacoes_pj": 970032,
      "valor_moveis_pj": 530400,
      "valor_inicial_pj": 1000000,
      "reservas_pj": "Exemplo de reservas",
      "concorrentes_diretos_pj": "Exemplo de concorrentes",
      "despesas_fixas_mensais_pj": "Exemplo de despesas fixas",
      "predio_proprio_pj": "N",
      "valor_aluguel_mes_pj": 2000,
      "principais_clientes_pj": "Exemplo de principais clientes",
      "segmento_razao": "Segmento",
      "codigo_documento": 1,
      "naturalidade_estado": "SE",
      "numero_livro": "Livro 01",
      "numero_folha": "Folha 10",
      "cartorio_comarca": "1º Cartório de Registro Civil",
      "codigo_profissao": "ANAL",
      "logradouro": "Rua",
      "cliente_tipo": "F",
      "inscricao_estadual": "123.987.283.874",
      "nome_fantasia": "CV Tecnologia",
      "nire": "35300186698",
      "trabalho_cidade": "São Paulo",
      "trabalho_pais": "BR",
      "trabalho_estado": "SP",
      "data_vigencia_contrato": "2025-12-31",
      "tags": [
        "Bom pagador"
      ]
    }
  ]
}