Sign in
latestOpenAPI 3.0.02026-07-264636241.7 MB

42bf5add8bf3

Tipos de Associações

Listar tipos de associações (v4)

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Retorna a lista paginada de tipos de associações cadastrados. Autenticação via JWT.

get/v4/cadastros/tipos-associacoes

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.

sortstring
Example:idusuario

Informa o campo a ser ordenado.

order'ASC' | 'DESC'

Informa a ordem da classificação.

search[like|nome]string
Example:Cônjuge

Filtrar por nome (busca parcial)

search[equal|idtipo]integer
Example:1

Filtrar por ID exato

search[equal|ativo_painel]boolean
Example:true

Filtrar por ativo no painel (S=Sim, N=Não)

search[equal|representante_legal]boolean

Filtrar por representante legal (S=Sim, N=Não)

search[equal|conjuge]boolean
Example:true

Filtrar por cônjuge (S=Sim, N=Não)

search[equal|avalista]boolean

Filtrar por avalista (S=Sim, N=Não)

search[equal|aprovacao_juridica]boolean

Filtrar por aprovação jurídica (S=Sim, N=Não)

search[equal|exibir_para_pessoa]'FIS' | 'JUR' | 'AMB'
Example:AMB

Filtrar por tipo de pessoa (FIS=Física, JUR=Jurídica, AMB=Ambas)

search[equal|exibir_lead]boolean
Example:true

Filtrar por exibir para lead (S=Sim, N=Não)

search[equal|locatario]boolean

Filtrar por locatário (S=Sim, N=Não)

search[equal|familiar]boolean

Filtrar por familiar (S=Sim, N=Não)

search[equal|unificar_lead]boolean

Filtrar por unificar lead (S=Sim, N=Não)

search[equal|procurador]boolean

Filtrar por procurador (S=Sim, N=Não)

search[equal|gerar_cartas_etiquetas]boolean
Example:true

Filtrar por gerar cartas/etiquetas (S=Sim, N=Não)

search[equal|visualiza_unidades_portal]boolean
Example:true

Filtrar por visualiza unidades portal (S=Sim, N=Não)

search[equal|participa_renda_total]boolean
Example:true

Filtrar por participa renda total (S=Sim, N=Não)

search[equal|exibir_cliente]boolean
Example:true

Filtrar por exibir para cliente (S=Sim, N=Não)

search[equal|codigointerno]integer
Example:1

Filtrar por código interno exato

search[equal|associacao_erp]string
Example:A

Filtrar por associação ERP (1 caractere)

search[equal|data_cad]string date-time
Example:2024-01-15 14:30:00

Filtrar por data de cadastro exata

Response

Listagem paginada de tipos de associações

statusstring
codeinteger

Example response

{
  "status": "sucesso",
  "code": 200,
  "pagination": {
    "pagina": 1,
    "registros": 30,
    "totalRegistros": 50,
    "totalPaginas": 2
  },
  "data": [
    {
      "idtipo": 1,
      "nome": "Cônjuge",
      "ativoPainel": true,
      "dataCad": "2024-01-15 14:30:00",
      "conjuge": true,
      "exibirParaPessoa": "AMB",
      "exibirLead": true,
      "gerarCartasEtiquetas": true,
      "visualizaUnidadesPortal": true,
      "participaRendaTotal": true,
      "exibirCliente": true
    }
  ]
}