v1

latestOpenAPI 3.0.02026-08-061280285.2 KB

Candidate APIs

Lists all job-candidate custom fields.

get/api/external/job-candidate/custom-field/list

Query parameters

include_countstring

Count of total records

Headers

RF-Api-Keystring

Response

Auto generated using Swagger Inspector

{"stackTrail":"paths:/api/external/job-candidate/custom-field/list:get:responses:200:content:application/json:schema","oasType":"schema","type":"unknown","example":{"data":[{"id":101,"name":"Expected salary","type":"money"},{"choices":[{"id":1,"name":"Yes"},{"id":2,"name":"No"}],"id":102,"name":"Willing to relocate?","type":"single_select"}],"total_items":2}}

Example response

{
  "data": [
    {
      "id": 101,
      "name": "Expected salary",
      "type": "money"
    },
    {
      "choices": [
        {
          "id": 1,
          "name": "Yes"
        },
        {
          "id": 2,
          "name": "No"
        }
      ],
      "id": 102,
      "name": "Willing to relocate?",
      "type": "single_select"
    }
  ],
  "total_items": 2
}