Sign in

v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Campos Adicionais

Listar campos adicionais

🔒 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 listagem paginada de campos adicionais cadastrados.

get/v4/configuracoes/campos-adicionais

Query parameters

paginainteger
Example:1

Página que deseja visualizar.

registros_por_paginainteger
Example:30

Quantidade de registros por página (máximo 500).

sortstring
Example:idcampo

Campo para ordenação.

order'ASC' | 'DESC'
Example:ASC

Direção da ordenação.

search[like|nome]string
Example:Oportunidade

Filtro por nome do campo (LIKE).

search[equal|idcampo]integer
Example:660

Filtro por ID do campo (igualdade).

search[equal|tipo]string
Example:numero

Filtro por tipo do campo (igualdade).

search[equal|obrigatorio]boolean
Example:true

Filtro por obrigatoriedade do campo (igualdade).

search[equal|ordemExibicao]integer
Example:1

Filtro por ordem de exibição (igualdade).

search[equal|linhaReferencia]string
Example:novo_marcelo

Filtro por linha de referência (igualdade).

search[equal|nomeReferencia]string
Example:marcelo_novo

Filtro por nome de referência (igualdade).

search[equal|ativoPainel]boolean

Filtro por visibilidade no painel (igualdade).

search[equal|ativo]boolean

Filtro por status ativo do campo (igualdade).

string
OR
string[]

Filtra campos vinculados às funcionalidades informadas (IN). Aceita valor único (?funcionalidades=repasse) ou array (?funcionalidades[]=repasse&funcionalidades[]=lead).

Response

Campos adicionais retornados com sucesso.

statusstring
codeinteger

Example response

{
  "status": "sucesso",
  "code": 200,
  "pagination": {
    "pagina": 1,
    "registros": 10,
    "totalRegistros": 42,
    "totalPaginas": 5
  },
  "data": [
    {
      "idcampo": 42,
      "nome": "Origem do Lead",
      "tipo": "Texto",
      "ordemExibicao": 1,
      "linhaReferencia": "novo_marcelo",
      "nomeReferencia": "marcelo_novo",
      "funcionalidades": [
        "comissao",
        "repasse"
      ],
      "ativoPainel": true,
      "ativo": true,
      "dataCad": "2025-01-15"
    }
  ]
}