Skip to main content
GET
List custom field values for an entity

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>
required

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

Available options:
candidate,
job
entityId
integer
required

The ID of the candidate or job.

parentEntityType
string

Filter by parent entity type (e.g. work_experience for fields nested within a candidate's work experiences).

parentEntityId
integer

Filter by parent entity ID. For work experiences this is the work experience's unique ID, typically an epoch timestamp.

Response

Custom field values stored for the entity.

Envelope for the custom field value list of an entity.

status
enum<string>
required

Always success for successful requests.

Available options:
success
data
object[]
required