GET /hr_api/v1/candidates

Returns a list of successful Candidates

Params

Property Required Details Location

scope

Optionally override the default scope. Will be ignored if invalid.

Must be one of: active, have_no_profile, have_profile, interviewed, job_alerts_off, job_alerts_on, never_applied, offered, pending, successful, talent, unsuccessful, with_person_record.

 URL

page

Index returns 100 records per request. Defaults to 1.

Must be a Integer

 URL

Examples

GET /hr_api/v1/candidates
200
{
  "candidates": [
    {
      "uuid": "ae610f7a-ded9-48af-a757-24d6223e3410",
      "formatted_name": "Peter Testing Nash"
    },
    {
      "uuid": "a7f1d9dc-c5bb-4a14-ae49-48c746a13d3b",
      "formatted_name": "Peter Nash"
    },
    {
      "uuid": "af150c7a-038e-49db-9758-f7c06ef65055",
      "formatted_name": "Michael2 dfgsdf Hefferan1"
    },
    {
      "uuid": "2b8c602d-a9ff-4840-8f76-46c6d930895a",
      "formatted_name": "Game 2 Boy"
    },
    {
      "uuid": "46b43665-33af-42da-83bc-a54d3212d9c4",
      "formatted_name": "Peter C Nash"
    },
    {
      "uuid": "277f575f-24d7-4247-8313-66b66490ed22",
      "formatted_name": "VMS TEST ACC"
    },
    {
      "uuid": "3583f915-240c-4881-9dfc-ce912e026e13",
      "formatted_name": "VMS TEST 08 ACC"
    },
    {
      "uuid": "049fb16e-207d-46c9-a765-754fdd0020c0",
      "formatted_name": "Adam Social"
    },
    {
      "uuid": "0acc2fbe-ac4f-46d3-96bd-8e341e1a37e4",
      "formatted_name": "VMS TEST IE7"
    },
    {
      "uuid": "66b95924-c01d-4f59-9701-5ccbc19dfda4",
      "formatted_name": "sdfgsdf Boot Tester"
    }
  ]
}