Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Custom Field

customField.info

Get information about a custom field.

Requires the hiringProcessMetadataRead permission.

post/customField.info

Request body

customFieldIdstring uuid required

The id of the custom field to fetch

Example request

{
  "customFieldId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
}

Response

Responses from the customField.info endpoint

OR

Example response

{
  "success": true,
  "results": {
    "id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
    "title": "Preferred Team",
    "description": "A description of the custom field",
    "objectType": "Application",
    "isArchived": false,
    "isPrivate": false,
    "fieldType": "String",
    "isRequired": false
  }
}