Skip to main content
GET
List custom fields

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.

Query Parameters

entityType
enum<string>

Filter by entity type: candidate or job. The entity a custom field applies to.

Available options:
candidate,
job

Response

Custom field definitions for the company.

Envelope for the custom field definition list.

status
enum<string>
required

Always success for successful requests.

Available options:
success
data
object[]
required