Corretor

Retorna um ou vários corretores.

🔒 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 corretores 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 pode retornar um objeto com dados de determinado corretor ou um array com os dados de todos os corretores, dependendo do parâmetro passado na URL.

get/cadastros/corretores

Request

  • Base URL
    https://integracao.cvcrm.com.br/api
  • URL
    https://integracao.cvcrm.com.br/api/cadastros/corretores
  • Auth
    none declared. Required headers: email, token

Query parameters

idinteger
Example:520

id do corretor

documentostring
Example:123.456.759-10 ou 12.345.678/9101-12

Documento

nomestring
Example:José

Nome do corretor

documento_faturamentostring
Example:123.456.759-10 ou 12.345.678/9101-12

Documento Faturamento

limitinteger
Example:30

Limite de corretores exibidos

offsetinteger

resultado do inicio(não deve ser usado caso pesquise um corretor específico)

Headers

emailstring required

E-mail para autenticação do usuário em retorno de corretor(es)

Example:email@email.com

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

tokenstring required

Tken para autenticação do usuário em retorno de corretor(es)

Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para consulta de corretores.

Response

Corretor

codigostring
limitinteger
offsetinteger

Example response

{
  "codigo": "200",
  "limit": 500,
  "corretor": [
    {
      "idcorretor": "25",
      "nome": "Corretor Teste",
      "email": "usuario@corretor.com.br",
      "documento": "81815454123",
      "tipo_corretor": "F",
      "idcorretor_int": "34437",
      "cnpj_faturamento": "56015306000176",
      "nome_fantasia": "MCM Corretor",
      "telefone": "+5565567891234",
      "idimobiliaria": "1",
      "ativo_login": "S",
      "apelido": "apelido do corretor",
      "genero": "M (Masculino) F (Feminino)",
      "estado_civil": "casado",
      "data_de_nascimento": "29/06/1985",
      "data_nasc": "1985-06-29",
      "celular": "+5579999889988",
      "rg": "00.000.000-0",
      "rg_orgao_expedidor": "SSP",
      "numero_pis": "1233456",
      "cracha": "1233456",
      "naturalidade": "itabaiana",
      "nacionalidade": "Brasil",
      "quantidade_filhos": 2,
      "dependentes": "S",
      "tamanho_camisa": "P",
      "observacoes": "observações",
      "nivel": "Nível 1",
      "categoria": "Categoria Ouro",
      "time": "Time Corretor",
      "idtime": 123,
      "corretor_parceiro": "N",
      "notificar_novos_leads": "N",
      "receber_email_leads_a_vencer": "S",
      "data_cad": "01/01/2023",
      "imagem_perfil": [
        {
          "avatar_nome": "imagem_avatar.jpg",
          "avatar_servidor": "20191205145829_5de945457758e.jpg",
          "avatar_tipo": "image/jpeg",
          "avatar_tamanho": "12993",
          "avatar_imagem": "https://cv.cvcrm.com.br/api/get/avatar/corretores/1234567890_123456789.jpg"
        }
      ],
      "endereco": [
        {
          "cep": "49010150",
          "logradouro_nome": "Rua",
          "endereco": "Rua Pacatuba",
          "bairro": "Centro",
          "numero": "21",
          "complemento": "casa",
          "cidade": "Aracaju",
          "estado": "Sergipe",
          "pais": "Brasil"
        }
      ],
      "formacao_academica": "MS",
      "curso": "Engenheiro Civil",
      "ano_conclusao": "2020",
      "conhecimento_office": "BA",
      "conhecimento_email": "IN",
      "outros_curso_relevantes": "Cursos de paisagismo",
      "codigo_interno": "34437",
      "identificador": "6005",
      "dados_creci": [
        {
          "creci": "74463",
          "situacao": "S",
          "tipo": "D",
          "estado_creci": "SE",
          "cidade_creci": "Aracaju",
          "vencimento": "2025-06-01"
        }
      ],
      "informacoes_bancarias": [
        {
          "tipo_de_conta": "C",
          "banco": "Banco do Brasil S.A.",
          "agencia": "Agência UFS",
          "numero_agencia": 5657,
          "conta": 15123,
          "digito_conta": 9,
          "tipo_documento": "CPF",
          "cpf_titular": "51606087452",
          "favorecido": "José Abelardo"
        }
      ],
      "inscricao_estadual": "74952482-0",
      "imobiliaria": {
        "idimobiliaria": 1,
        "idimobiliaria_int": "5",
        "nome_fantasia": "Imob Teste",
        "cnpj": "12345678000195",
        "email": "contato@imobiliaria.com.br",
        "celular_imobiliaria": "79999998877",
        "telefone_imobiliaria": "7933334455",
        "creci_imobiliaria": "12345",
        "cep_imobiliaria": "49010150",
        "endereco_imobiliaria": "Rua Pacatuba",
        "bairro_imobiliaria": "Centro",
        "cidade_imobiliaria": "Aracaju",
        "estado_imobiliaria": "SE"
      }
    }
  ]
}

Changes

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