Candidates

Supported Formats: json
View

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"
    }
  ]
}
View

GET /hr_api/v1/candidates/:uuid

Return details of an existing Candidate

Params

Property Required Details Location

uuid

Must be a String

 URL

Examples

GET /hr_api/v1/candidates/:uuid
200
{
  "candidate": {
    "uuid": "e5267be7-86b6-4ba5-a5a9-fc76fe6b0cfe",
    "status": "inactive",
    "entered_by_type": "applicant",
    "transferred_to_vms_at": null,
    "vms_transfer_status": null,
    "control_data": {
      "manual_candidate": {
        "publication_scope_name": null,
        "create_portal_login": null,
        "candidate_supplier_id": null,
        "supplier_name": null,
        "consultant_name": null,
        "position_reference": null
      }
    },
    "vms_account_status": "deleted_by_user",
    "person": {
      "uuid": "3ee87103-d4cf-42e1-9692-671ac6f3971a",
      "status": "inactive",
      "formatted_name": "FN1 One",
      "given_name": "FN1",
      "family_name": "One",
      "form_of_address": "",
      "middle_name": "",
      "preferred_name": null
    },
    "applications": [
      {
        "uuid": "07242ed1-c608-4b20-b5ad-b09e7f859877",
        "status": "pending_archive"
      },
      {
        "uuid": "1961e39b-3af7-4bd9-a162-ff05d58e6985",
        "status": "pending_archive"
      },
      {
        "uuid": "caf6e0ff-02c9-4206-8a2f-b0282f7df954",
        "status": "pending_archive"
      },
      {
        "uuid": "d342544f-81d8-46d8-94e6-62a4a32aa18b",
        "status": "pending_archive"
      },
      {
        "uuid": "83c1c652-86fd-4851-b3e5-a18ca76ebf97",
        "status": "pending_archive"
      },
      {
        "uuid": "47327e00-ea67-478a-a06c-7132f066ef99",
        "status": "complete"
      },
      {
        "uuid": "6ee6f405-5110-4b90-98cb-401aa55afd84",
        "status": "pending_archive"
      },
      {
        "uuid": "403d613e-084e-4138-a759-6ced55b8868a",
        "status": "complete"
      }
    ]
  }
}