v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Tipos de Associações

Retorna os tipos de associações disponíveis

🔒 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)

A api tem por objetivo demonstrar os tipos de associações cadastradas no ambiente do cliente. Denomina-se associação no construtor de vendas, a ligação das pessoas participantes da reserva com o titular. Ex.: Sócio, Conjuge, Repreentante.

O campo exibir para pessoa (exibir_para_pessoa) faz a relação se o tipo de associação estará vinculado somente as pessoas do tipo Física, Jurídica ou ambos quando for pertinente aos dois tipos de pessoas. FISISCA (Física), JURIDICA (Jurídica), AMBOS (Física e Jurídica)

get/v1/cadastros/tipos-associacoes

Query parameters

paginainteger

Example:1

Número da página que retorna os tipos de associações

registros_por_paginainteger

Example:100

Quantidade de registros por página que retorna tipos de associações

exibir_para_pessoastring

Example:FISICA/JURIDICA

Filtro por pessoas físicas ou jurídicas

Headers

emailstring required

Example:email@email.com

E-mail de autenticação para retornar tipos de associações

tokenstring required

Example:2ed820f89afa16cabb6f1585f9a85b4e6bfc80c3

Token de autenticação para retornar tipos de associações

Response

Tipos de Associações

paginainteger

total_de_paginasinteger

registrosinteger

total_de_registrosinteger

Example response

{
  "pagina": 1,
  "total_de_paginas": 36,
  "registros": 30,
  "total_de_registros": 1054,
  "dados": [
    {
      "idtipo": 1,
      "nome": "Procurador",
      "conjuge": "S",
      "avalista": "S",
      "exibir_para_pessoa": "FISICA|JURIDICA|AMBOS"
    }
  ]
}