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