Campos Personalizados

Obter Campos Personalizados de uma entidade

Este endpoint retorna todos os campos personalizados configurados para uma entidade específica. As entidades suportadas são:

REQUISITIONS – Requisições de vagas

JOBS – Vagas

TALENTS – Talentos

JOB_TALENTS – Candidaturas de talentos a vagas

ALL - Todos os campos

A resposta inclui informações completas de cada campo personalizado, como nome, tipo, obrigatoriedade, opções e configurações de exibição

get/custom-data-manager/custom-fields/entity/{entity}

Request

Base URL: https://api.inhire.app
URL: https://api.inhire.app/custom-data-manager/custom-fields/entity/{entity}
Auth: HTTP bearer

Path parameters

entitystring required

Headers

X-Tenantstring required

Multi-tenant identifier. Required on every request. This determines which tenant's data the request operates on. Maps to the DynamoDB partition key (tenantId).

Response

archivedAtstring

Timestamp ISO-8601.

createdAtstring required

Timestamp ISO-8601 de criação do recurso.

deletedAtstring

Timestamp ISO-8601 do soft-delete (quando aplicável).

entity'JOB_TALENTS' | 'JOBS' | 'REQUISITIONS' | 'TALENTS' | 'POSITION' required

Tipo de entidade à qual o recurso se aplica (JOBS, TALENTS, JOB_TALENTS, etc.).

idstring required

Identificador único do recurso (ULID).

isEditableOnstring[]

Flag booleana de domínio (ver campo equivalente nos types TS).

namestring required

Nome legível do recurso.

nameReadOnlyboolean

Nome somente-leitura (ex.: extraído de fonte externa e não editável).

ordernumber

Ordem de exibição do item dentro da coleção (numérico, crescente).

requiredboolean required

Indica se o campo é obrigatório.

requiredInstring[]

Lista de telas/contextos em que o campo é obrigatório.

showInstring[]

Lista de telas/contextos em que o campo é exibido.

status'enabled' | 'archived'

Status atual do recurso (enum específico do domínio).

tenantIdstring required

Identificador do tenant (cliente InHire) ao qual o recurso pertence.

Tipo do recurso/valor (enum específico do contexto).

updatedAtstring required

Timestamp ISO-8601 da última atualização do recurso.

Changes

No recorded changes to this operation across all 1 revision of this API.