v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Usuários Imobiliárias

Retorna usuários de imobiliárias

🔒 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 todas usuários imobiliarias cadastradas no CV, podendo filtrar pelo documento (cpf) ou id do usuário.

get/v1/cadastros/usuarios-imobiliarias

Query parameters

offsetinteger

registro inicial

limitinteger

Example:30

quantidade de registros (caso não passe retorna todos)

idusuarioimobiliaria_cvinteger

Example:123456

Identificador do usuário de imobiliária

idusuarioimobiliaria_intstring

Example:123456

Identificador do usuário de imobiliária no sistema legado

documentostring

Example:123456

Documento do usuário de imobiliária

nomestring

Example:Maria

Nome do usuário de imobiliária

Headers

emailstring required

Example:email@email.com

E-mail de autenticação para retorno de usuários de imobiliárias.

tokenstring required

Example:2ed820f89afa16cabb6f1585f9a85b4e6bfc80c3

Token de autenticação para retorno de usuários de imobiliárias.

Response

Usuários Imobiliárias

totalinteger

Total

offsetinteger

Offset

limitinteger

Limit

Example response

{
  "total": 1,
  "usuarios": [
    {
      "idusuarioimobiliaria_cv": 123,
      "idusuarioimobiliaria_int": 123,
      "idimobiliaria_cv": 123,
      "idimobiliaria_int": "123",
      "imobiliaria": "Imobiliaria teste",
      "nome": "123",
      "documento": "12345678910",
      "email": "usuario@imobiliaria.com",
      "data_nasc": "01/01/1999",
      "telefone": "+5579999878877",
      "celular": "+5579999878877",
      "creci": "214124213",
      "endereco": {
        "cep": "49080000",
        "logradouro": "Rua",
        "endereco": "Rua Tal",
        "bairro": "Novo paraiso",
        "numero": "1000",
        "complemento": "Colombia",
        "estado": "Sergipe",
        "cidade": "Aracaju"
      },
      "dados_faturamento": {
        "nome_faturamento": "Josefa",
        "cpf_faturamento": "68169134005",
        "cnpj_faturamento": "12098292000126",
        "codigo_interno_faturamento": "123",
        "data_faturamento": "01/01/1999",
        "creci_faturamento": 1234,
        "tipo_conta_faturamento": "P",
        "banco_faturamento": "Banco do Brasil",
        "nome_agencia_faturamento": "agenia nome",
        "numero_agencia_faturamento": 1234,
        "digito_agencia_faturamento": 1,
        "numero_conta_faturamento": 1234,
        "digito_conta_faturamento": 1,
        "email_faturamento": "faturamento@email.com",
        "telefone_faturamento": "+5579999766677",
        "celular_faturamento": "+5579999766677"
      }
    }
  ]
}