Skip to main content
GET
Get a custom field

Authorizations

Authorization
string
header
required

Company-scoped API key. Production keys are prefixed sk_live_, sandbox keys sk_test_, each followed by 22 base62 characters (pattern ^sk_(live|test)_[0-9A-Za-z]{22}$). Generate keys in the TapTalent dashboard under Account Settings → Developers → API Key Management; a key is shown once at generation and old keys are invalidated immediately on regeneration.

Path Parameters

customFieldId
integer
required

The unique identifier of the custom field. The published documentation types this parameter as a string, but this specification models the underlying integer identifier used by the API (the custom-field-values endpoints take customFieldId as an integer).

Response

The custom field definition.

Envelope for a single custom field definition.

status
enum<string>
required

Always success for successful requests.

Available options:
success
data
object
required

A custom field definition (field template) for candidates or jobs.