Campos Personalizados

Detalhar campo personalizado

GET · API de Integração v2

GET/v2/campos-personalizados/{id}

Detalhar campo personalizado

Retorna a definição completa pelo id, no escopo do escritório autenticado (404 se não for do escritório).

Autenticação

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

Parâmetros de caminho1

idintegerobrigatório

ID da definição

exemplo: 12

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

{
  "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"
}

Contrato de respostas

200Definição encontrada.

Definição encontrada.

application/json

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

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

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

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

404Campo não encontrado no escritório autenticado.

Campo não encontrado no escritório autenticado.

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

curl --request GET \
  --url 'https://api.expedit.com.br/v2/campos-personalizados/12' \
  --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

{
  "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"
}

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