---
title: "Listar metadados dos campos adicionais disponíveis para a Requisição de Admissão"
method: GET
path: "/v1/funcionarios/metadados-campos-adicionais"
tags: ["HCM Cadastros"]
---

# Listar metadados dos campos adicionais disponíveis para a Requisição de Admissão

`GET /v1/funcionarios/metadados-campos-adicionais`

## Request

- Base URL: `https://api.sankhya.com.br`
- URL: `https://api.sankhya.com.br/v1/funcionarios/metadados-campos-adicionais`
- Auth: API key in header `Authorization`

Este endpoint retorna o catálogo de campos adicionais (personalizados) cadastrados na entidade Funcionário e válidos para uso na Requisição de Admissão — nome, tipo de dado, obrigatoriedade, tamanho máximo e opções válidas (para campos de lista). Use este endpoint para descobrir programaticamente quais campos podem ser enviados no array `camposAdicionais` do endpoint `POST /v2/funcionarios/admissao`, e em qual formato, sem precisar consultar manualmente o Dicionário de Dados.

Apenas campos ativos e com prefixo `AD_` são retornados. Campos dos tipos Hora, Binário e Texto Longo (CLOB) — incluindo as variações Arquivo, Múltiplo Arquivo e Texto com Formatação HTML — não são suportados no fluxo de admissão e não aparecem na resposta.

Caso o cliente não possua nenhum campo adicional cadastrado, a resposta é `200` com `camposAdicionais` vazio e `totalCampos` igual a `0`.

## Query parameters

- `page` integer
- `pageSize` integer

## Response `200`

Lista de campos adicionais retornada com sucesso.

- MetadadosCamposAdicionaisResponse
  - `camposAdicionais` CampoAdicionalMetadado[]
    - `nomeCampo` string: Nome exato do campo adicional, conforme cadastrado no Dicionário de Dados. É o valor a ser usado em `nomeCampo` no array `camposAdicionais` do `POST /v2/funcionarios/admissao`.
    - `descricao` string: Descrição legível do campo, conforme cadastrada no Dicionário de Dados.
    - `tipo` 'TEXTO' | 'INTEIRO' | 'DECIMAL' | 'DATA' | 'DATA_HORA' | 'CHECKBOX' | 'LISTA_OPCOES': Tipo de dado do campo e o formato esperado em `valor` ao enviar este campo no `POST /v2/funcionarios/admissao`: | Valor | Significado | Formato esperado em `valor` no POST | |---|---|---| | `TEXTO` | Texto | string | | `INTEIRO` | Número Inteiro | number, sem casas decimais | | `DECIMAL` | Número Decimal | number | | `DATA` | Data | string, formato ISO 8601 (YYYY-MM-DD) | | `DATA_HORA` | Data e Hora | string, formato ISO 8601 (YYYY-MM-DD) | | `CHECKBOX` | Checkbox | boolean | | `LISTA_OPCOES` | Lista de Opções | string, com o valor de uma das opções em `opcoes` (não a descrição) |
    - `obrigatorio` boolean: Indica se o campo é obrigatório, conforme configurado no Dicionário de Dados. Atenção: o `POST /v2/funcionarios/admissao` não bloqueia a requisição por falta deste campo mesmo quando `obrigatorio` é `true` — a requisição é criada normalmente (200) e fica pendente para complementação posterior.
    - `tamanhoMaximo` integer: Tamanho máximo permitido para o valor do campo, conforme configurado no Dicionário de Dados.
    - `opcoes` object[]: Lista de opções válidas para o campo. Presente apenas para campos do tipo Lista de Opções (`tipo` = `L`); array vazio para os demais tipos.
      - `valor` string: Valor da opção. É este valor (não a descrição) que deve ser enviado em `valor` no `POST /v2/funcionarios/admissao`.
      - `descricao` string: Descrição legível da opção.
  - `totalCampos` integer: Total de campos adicionais disponíveis, considerando todas as páginas (não apenas a página atual).
  - `page` integer: Página atual retornada.
  - `pageSize` integer: Quantidade de itens por página utilizada nesta resposta.

## Other responses

- `401`: Não autenticado. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.
- `500`: Erro interno no servidor. Clique [aqui](https://developer.sankhya.com.br/reference/c%C3%B3digos-de-retorno-da-api) para mais detalhes.

## Changes

- **2026-11-03** `b3c833e7aab1`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/sankhya/apis/api-sankhya/changes/v1/funcionarios/metadados-campos-adicionais/get.md)

---

[API](https://skmtc.dev/sankhya/apis/api-sankhya.md) - [All operations](https://skmtc.dev/sankhya/apis/api-sankhya/llms.txt) - [OpenAPI document](https://skmtc.dev/sankhya/apis/api-sankhya/revisions/b3c833e7aab1?raw)