CVcvcrm
Tipos de Arquivos

Listar tipos de arquivos

🔒 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 listagem paginada de tipos de arquivos ativos. Autenticação via JWT Bearer token. Os filtros aceitam o padrão search[operador|campo]=valor. Operadores disponíveis: equal (igual), notEqual (diferente), like (contém), in (lista), notIn (fora da lista), greaterThan (maior que), lessThan (menor que), isNull (campo não preenchido), isNotNull (campo preenchido). Exemplo: search[like|nome]=RG, search[equal|ativoPainel]=S, search[equal|funcionalidade]=reservas

get/v4/configuracoes/tipos-arquivos

Request

  • Base URL
    https://integracao.cvcrm.com.br/api
  • URL
    https://integracao.cvcrm.com.br/api/v4/configuracoes/tipos-arquivos
  • Auth
    HTTP bearer

Query parameters

paginainteger
Example:1

Página que deseja visualizar os registros.

registros_por_paginainteger
Example:30

Quantidade de registros por página, máximo 500 registros.

sortstring
Example:idtipo

Campo de ordenação.

order'ASC' | 'DESC'

Ordem da classificação.

search[like|nome]string
Example:RG

Filtra por nome (contém o valor informado).

search[equal|tipoPessoa]1 | 2 | 3
Example:1

Filtra pelo tipo de pessoa: 1 = Física, 2 = Jurídica, 3 = Física/Jurídica (Ambos).

search[equal|funcionalidade]'reservas' | 'pre_cadastro' | 'ambos'
Example:reservas

Filtra pela funcionalidade do tipo de arquivo.

search[equal|visivelPara]'T' | 'G'
Example:T

Filtra pela visibilidade: T (Todos) ou G (Gestor).

search[equal|ativoPainel]'S' | 'N'
Example:S

Filtra por ativo no painel.

search[equal|obrigatorioWorkflow]'S' | 'N'
Example:N

Filtra por obrigatório no workflow.

search[equal|assinaturaDigital]'S' | 'N'
Example:N

Filtra por assinatura digital.

search[equal|contrato]'S' | 'N'
Example:N

Filtra por tipo de contrato.

search[equal|exibirGestaoContrato]'S' | 'N'
Example:N

Filtra por exibição na gestão de contratos.

search[equal|exibirPainelCliente]'S' | 'N'
Example:S

Filtra por exibição no painel do cliente.

search[equal|utilizarSmartDocs]'S' | 'N'
Example:S

Filtra por utilização do SmartDocs.

search[equal|possuiValidade]'S' | 'N'
Example:N

Filtra por tipos que possuem prazo de validade.

Response

Tipos de arquivos retornados com sucesso.

statusstring
codeinteger

Example response

{
  "status": "success",
  "code": 200,
  "pagination": {
    "pagina": 1,
    "registros": 30,
    "totalRegistros": 120,
    "totalPaginas": 4
  },
  "data": [
    {
      "idtipo": 10,
      "nome": "RG",
      "tipoPessoa": 3,
      "tipoPessoaDescricao": "Física / Jurídica",
      "ordem": 1,
      "visivelPara": "T",
      "exibirPainelCliente": true,
      "utilizarSmartDocs": true,
      "funcionalidade": "ambos",
      "ativoPainel": true,
      "dataCad": "2024-01-15 10:30:00",
      "tempoValidade": 12
    }
  ]
}

Changes

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