Campos Personalizados

Listar campos personalizados (paginado)

GET · API de Integração v2

GET/v2/campos-personalizados

Listar campos personalizados

Listagem administrativa das definições do escritório (tela de gerenciamento), com filtro por nome e paginação.

Para montar formulários de cadastro (pessoa/processo), prefira GET /v2/campos-personalizados/opcoes?type=… — resposta enxuta e focada no que o front precisa.

Escopo: o escritório vem do token — a listagem traz apenas os campos do seu escritório.

Autenticação

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

Parâmetros de consulta3

nomestring

Filtro por nome (contém, case-insensitive)

exemplo: Origem

paginainteger

Página (1-based)

exemplo: 1padrão: 1

tamanhointeger

Itens por página

exemplo: 15padrão: 15

Respostas2

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

{
  "content": [
    {
      "createdAt": "2024-02-02 23:59:58",
      "id": 1,
      "mascara": "CEP",
      "nome": "string",
      "opcoes": [
        "string"
      ],
      "tipo": "PESSOA",
      "tipoEntrada": "DATA",
      "updatedAt": "2025-02-02 23:59:59"
    }
  ],
  "pageNumber": 0,
  "pageSize": 10,
  "totalElements": 2,
  "totalPages": 1
}

Contrato de respostas

200Página de campos personalizados.

Página de campos personalizados.

application/json

contentCampoPersonalizadoResponseDTO[]

List of requested elements.

Ver propriedades

createdAtstring

exemplo: 2024-02-02 23:59:58

idinteger

formato: int64

mascarastring

valores: CEP · CNPJ · CPF · EMAIL · LINK · NORMAL · TELEFONE · VALOR

nomestring

opcoesstring[]

tipostring

valores: PESSOA · PROCESSO

tipoEntradastring

valores: DATA · ESCOLHA_UNICA · MULTIPLA_ESCOLHA · NUMERO · SELECAO · TEXTO · TEXTO_LONGO

updatedAtstring

exemplo: 2025-02-02 23:59:59

pageNumberinteger

Requested page.

formato: int32exemplo: 0

pageSizeinteger

Requested number of elements per page.

formato: int32exemplo: 10

totalElementsinteger

Total amount of elements.

formato: int64exemplo: 2

totalPagesinteger

Total amount of pages based on current pageSize.

formato: int32exemplo: 1

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

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

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

curl --request GET \
  --url 'https://api.expedit.com.br/v2/campos-personalizados?pagina=1&tamanho=15' \
  --header 'Accept: application/json' \
  --header 'X-API-Key: SUA_API_KEY'

Requisição e resposta

As chamadas são enviadas diretamente à API. O domínio deste portal precisa estar autorizado no CORS.

A resposta aparecerá aquiPreencha os campos e envie a requisição para consultar o retorno da API.

Explorar exemplos de resposta

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

{
  "content": [
    {
      "createdAt": "2024-02-02 23:59:58",
      "id": 1,
      "mascara": "CEP",
      "nome": "string",
      "opcoes": [
        "string"
      ],
      "tipo": "PESSOA",
      "tipoEntrada": "DATA",
      "updatedAt": "2025-02-02 23:59:59"
    }
  ],
  "pageNumber": 0,
  "pageSize": 10,
  "totalElements": 2,
  "totalPages": 1
}

Exemplos e campos gerados do contrato OpenAPI. Revise os valores antes de integrar.