Campos Personalizados

Opções de campos personalizados (para formulários)

GET · API de Integração v2

GET/v2/campos-personalizados/opcoes

Opções de campos personalizados

Lista enxuta das definições ativas do seu escritório, para o front montar o formulário de cadastro/edição. Filtre pela entidade com type.

Parâmetro: type=PESSOA ou type=PROCESSO (maiúsculas). Escopo do escritório vem do token.

Cada item traz: id (é este que vai depois em camposPersonalizados[].campoId), nome, tipoEntrada, mascara e opcoes (preenchido só para seleção/escolha única/múltipla escolha).

Exemplo: [ { "id": 12, "nome": "Origem", "tipoEntrada": "TEXTO", "mascara": "NORMAL", "opcoes": [] }, { "id": 21, "nome": "Canais", "tipoEntrada": "MULTIPLA_ESCOLHA", "mascara": "NORMAL", "opcoes": ["A","B","C"] } ]

tipoEntrada (widget que captura o valor):

ValorWidgetUsa opções?
TEXTOCampo de texto curtoNão
NUMERONúmeroNão
DATADataNão
TEXTO_LONGOÁrea de textoNão
SELECAOLista suspensa (1 valor)Sim
ESCOLHA_UNICARádio (1 valor)Sim
MULTIPLA_ESCOLHACheckbox (vários valores)Sim

mascara (formatação sugerida): NORMAL, TELEFONE, CPF, CNPJ, EMAIL, LINK, CEP, VALOR.

tipo (a que entidade o campo se aplica): PESSOA ou PROCESSO.

Autenticação

X-API-Key no cabeçalho. Como autenticar

Parâmetros de consulta1

typestringobrigatório

Entidade dos campos: PESSOA ou PROCESSO (maiúsculas).

exemplo: PESSOAvalores: PESSOA · PROCESSO

Respostas3

Exemplos ilustrativos · nenhuma requisição é enviada

200 · Sucesso

Quando acontece
A operação foi concluída.
Como tratar
Leia os dados retornados; em listagens, confira também a paginação.

Exemplo ilustrativo gerado do schema · application/json

Exemplo · HTTP 200
[
  {
    "id": 12,
    "mascara": "NORMAL",
    "nome": "Origem",
    "opcoes": [
      "A",
      "B"
    ],
    "tipoEntrada": "MULTIPLA_ESCOLHA"
  }
]

Contrato de respostas

200Lista de opções de campos do tipo pedido.

Lista de opções de campos do tipo pedido.

application/json

idinteger

ID da definição — é este que vai em camposPersonalizados[].campoId

formato: int64exemplo: 12
mascarastring

Máscara sugerida para o valor

valores: CEP · CNPJ · CPF · EMAIL · LINK · NORMAL · TELEFONE · VALORexemplo: NORMAL
nomestring

Rótulo do campo

exemplo: Origem
opcoesstring[]

Opções pré-definidas (só para seleção/escolha única/múltipla escolha)

exemplo: ["A","B"]
tipoEntradastring

Widget de entrada (define como renderizar/validar)

valores: DATA · ESCOLHA_UNICA · MULTIPLA_ESCOLHA · NUMERO · SELECAO · TEXTO · TEXTO_LONGOexemplo: MULTIPLA_ESCOLHA
400Parâmetro 'type' ausente ou inválido (use PESSOA ou PROCESSO).

Parâmetro 'type' ausente ou inválido (use PESSOA ou PROCESSO).

O contrato não declara um corpo para esta resposta.

401Não autenticado (token ausente/inválido).

Não autenticado (token ausente/inválido).

O contrato não declara um corpo para esta resposta.

© 2026 Expedit LawtechFeito para conectar.