v1

latestOpenAPI 3.0.12026-08-063985821.3 MB

Candidate API:Lists

Get a custom field definition

get/candidates/fields/custom/{fieldId}

Path parameters

fieldIdinteger required

Response

Requested candidate custom field definition

fieldIdinteger required

namestring required

type'Text' | 'List' | 'Date' | 'Lookup' | 'Url' string required

The type of value a custom field expects

mandatoryboolean nullable

Field is mandatory and a value must be provided

maxLengthinteger nullable

Maximum length of a text field

multiLineboolean nullable

Text field can contain a multi-line value

multiSelectboolean nullable

List field allows multiple selections

valuesstring[] nullable

Available values for a list custom field

Example response

{
  "fieldId": 1,
  "name": "Text Field 1",
  "type": "Text",
  "mandatory": true,
  "maxLength": 50,
  "multiLine": true,
  "multiSelect": false,
  "values": []
}