Position Openings

Supported Formats: json
View

GET /hr_api/v1/position_openings

Returns a list of open Position Openings

Params

Property Required Details Location

scope

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

Must be one of: closed_or_filled, is_open, unfilled.

 URL

page

Index returns 100 records per request. Defaults to 1.

Must be a Integer

 URL

Examples

GET /hr_api/v1/position_openings
200
{
  "position_openings": [
    {
      "uuid": "c334fec5-b133-48b0-ac8e-a9b9dbe67ba9",
      "position_reference": "ddnp7fStniSkYoQBNB5NUP",
      "status": "open"
    },
    {
      "uuid": "5a5508fd-b299-44cf-91ec-27ee5e6bb4c5",
      "position_reference": "bAvqJ9SPLeZ5hSj-5EA7tf",
      "status": "open"
    },
    {
      "uuid": "e33986c4-2276-4deb-a755-5a953374adaa",
      "position_reference": "dJoyBeiNzn66DvwPuZDk2Q",
      "status": "open"
    },
    {
      "uuid": "329b2b2a-07b5-4d85-9562-d7049809e3cb",
      "position_reference": "aYMYSQb7vnHzvI1WsycEpl",
      "status": "open"
    },
    {
      "uuid": "5cc4c30f-fa59-432e-ab55-5fa3e653fc4e",
      "position_reference": "bCXmmp-LLdlQTvx6pMu_Xo",
      "status": "open"
    },
    {
      "uuid": "18245f4b-9e41-4f3c-9178-939ea33eccec",
      "position_reference": "ayjf9lNKfppjf4K56JpSZS",
      "status": "open"
    },
    {
      "uuid": "502e6b92-e680-4b57-8307-e387c40f07ee",
      "position_reference": "bqlMUs5Oblv4mh44FedWFU",
      "status": "open"
    },
    {
      "uuid": "80524f84-9f43-45f9-8b9c-13f195ff3b18",
      "position_reference": "cauK-eN0nf-yUCe_gv_ZSy",
      "status": "open"
    },
    {
      "uuid": "10b657bd-7e5e-45b1-9c33-f4824ce4727a",
      "position_reference": "aqTLE9FL5fSzWZ9ijm5hj6",
      "status": "open"
    },
    {
      "uuid": "acca05cc-b375-4194-8b88-81ce627a7159",
      "position_reference": "cSYGxmS3vbLiUiGC5IENfz",
      "status": "open"
    },
    {
      "uuid": "8f952fa6-128f-479a-ae10-428e2890c7a7",
      "position_reference": "cpLs-MeO9hMQ4qqO4OKmEN",
      "status": "open"
    },
    {
      "uuid": "d07b4893-846c-4e2e-aea6-e9e2905871f8",
      "position_reference": "dqE0ItHgXolQ6M6Ekqwhh4",
      "status": "open"
    },
    {
      "uuid": "f4a4d3e1-e4d6-4772-aa59-ca210dc683f0",
      "position_reference": "d0PnpH5nzhCQPzYIenXOpW",
      "status": "open"
    },
    {
      "uuid": "388d8d11-5604-4c1e-b777-3ca14e30e97c",
      "position_reference": "a4Jy0rvGrmhRD3pkfomoL8",
      "status": "open"
    },
    {
      "uuid": "f5cc82b5-19da-4abd-9d07-9c0ca5f462a6",
      "position_reference": "d1Zik1gDPkVz0hNaYL9gkM",
      "status": "open"
    },
    {
      "uuid": "f049a47c-c0b6-430b-975e-959393c21b17",
      "position_reference": "dWsAr8Wlzdc5DELzotWHSx",
      "status": "open"
    },
    {
      "uuid": "6fa6782c-10f6-469f-9455-a9a45a936d07",
      "position_reference": "bVPNGSepzgN5rvQArAK20h",
      "status": "open"
    },
    {
      "uuid": "b7f64dcf-679b-42f9-9c35-d840c7a86612",
      "position_reference": "c39K3pz5Tc-zW12edhQgys",
      "status": "open"
    },
    {
      "uuid": "8aa469ab-c809-46c2-af08-54de135babd1",
      "position_reference": "ckPgMRYaLgWQ8ivn4tw6Vr",
      "status": "open"
    },
    {
      "uuid": "9161deef-8381-45e6-94d1-9bcfc612e3e5",
      "position_reference": "cryD7VG4ff5PtrM8_geUpL",
      "status": "open"
    },
    {
      "uuid": "f50ec959-b3a0-4f8e-b80d-50b2f303ca1e",
      "position_reference": "d1dSLzS6bpJRGnullZa8OE",
      "status": "open"
    },
    {
      "uuid": "ece028ec-30da-49a5-95ce-67f411328952",
      "position_reference": "dS4cJSmnPjPzxoz_qrmOLs",
      "status": "open"
    },
    {
      "uuid": "b996df5b-a144-4347-a259-f5b4352840fc",
      "position_reference": "c5LT9BOurdr6jz9Bq1ked8",
      "status": "open"
    },
    {
      "uuid": "bc036e90-3a17-41f6-afa3-a70bc5cb9c1e",
      "position_reference": "c8a26qoHDb9Q-JPWVfY5WE",
      "status": "open"
    },
    {
      "uuid": "984accb9-1e58-4b2e-8e2a-04a5eb7fd27a",
      "position_reference": "cysSY5hLHllO4QbkxRF9j6",
      "status": "open"
    },
    {
      "uuid": "39d37903-39cc-446f-b16e-93bc3c127015",
      "position_reference": "a503KdoCXeB7fUK7W8eNav",
      "status": "open"
    },
    {
      "uuid": "f8536e00-3d9f-475c-af80-de2aac297505",
      "position_reference": "d4u24apz9hxk-a3IQSkxuf",
      "status": "open"
    },
    {
      "uuid": "275f2b03-4899-4cd4-af18-8ec025cfc0bf",
      "position_reference": "aNxYSdsjLm1k8yJSaLZ8c_",
      "status": "open"
    },
    {
      "uuid": "9895b2c7-873f-41fe-899b-a32333154537",
      "position_reference": "cyLBlhHZ9b_OMBOYmZfuu3",
      "status": "open"
    },
    {
      "uuid": "741a5eea-58e3-4c3c-81f3-c636e74dbbd2",
      "position_reference": "b0gL7QwonmpihZXJBNtBVs",
      "status": "open"
    },
    {
      "uuid": "19d3c7b3-8be5-4ef1-8cc6-5a55f53b2f30",
      "position_reference": "az08EZI-vo8yZgwLx1oY8W",
      "status": "open"
    },
    {
      "uuid": "a4f95e4c-28fb-48d2-9988-7b83fb784748",
      "position_reference": "cK-v5mkpTi0PMiE4p7EeDi",
      "status": "open"
    },
    {
      "uuid": "a587abcc-6885-451c-9b3c-1605214ce0e7",
      "position_reference": "cLH6VmAivfhjS8fGuHtodN",
      "status": "open"
    },
    {
      "uuid": "031e54d3-f245-4590-90da-add08d5849e5",
      "position_reference": "adhLtt8KvfKjdARDcnweNL",
      "status": "open"
    },
    {
      "uuid": "80893c79-8fb2-4305-b694-ad861fdfbc9c",
      "position_reference": "caItX5J7jdbBAuRyyF37YC",
      "status": "open"
    },
    {
      "uuid": "63870117-6dd2-41ed-96ec-bf580437ed3f",
      "position_reference": "bJHWexBDjb7zBSV1Gen-0_",
      "status": "open"
    },
    {
      "uuid": "932afb0e-5b32-4de8-a699-fad000945dbc",
      "position_reference": "ctkVSowZjn6kAz-TaaLf28",
      "status": "open"
    },
    {
      "uuid": "dabdd0c8-879e-4db7-9587-4267d84ed1c3",
      "position_reference": "dAVDdiH55nT5whqMFytThd",
      "status": "open"
    },
    {
      "uuid": "8d432050-b89a-403a-9c14-52d7168dde08",
      "position_reference": "cnqYbqUjPaoPWuuTCwJD4i",
      "status": "open"
    },
    {
      "uuid": "66bf36a7-a963-41a0-bef6-7440c7c735ea",
      "position_reference": "bMVZANQwnbOl72DedhXZxQ",
      "status": "open"
    },
    {
      "uuid": "0c5d127f-1872-4ae7-b117-4e0c75a9ab4d",
      "position_reference": "amxrj_ghjk57extGX1QATn",
      "status": "open"
    },
    {
      "uuid": "be0fd314-1c5f-4b11-84fc-bfc6ba21429f",
      "position_reference": "c-d9muhf9leyt8V8A6iukF",
      "status": "open"
    },
    {
      "uuid": "4d1cd280-bc52-4ce3-93e0-a97471c71bff",
      "position_reference": "bnhnkaVfjm45pGQxrXXXV_",
      "status": "open"
    },
    {
      "uuid": "3b1e9036-dd26-4618-aebc-0ad37c8ff561",
      "position_reference": "a7hPa23szggk68cTn8J_vH",
      "status": "open"
    },
    {
      "uuid": "45c072a2-e875-4fd2-8a2c-69fcf697f289",
      "position_reference": "bfWhkI6hvp0OOSAFZ2L_kj",
      "status": "open"
    },
    {
      "uuid": "c1926e9a-a8be-4d84-b393-78f70b9cf6b2",
      "position_reference": "dbKM6AQl5nHlotEpClNpAY",
      "status": "open"
    },
    {
      "uuid": "50698047-39d9-41dd-b875-491b6a23a024",
      "position_reference": "bqAybhoDLb3BH1srTQi6aK",
      "status": "open"
    },
    {
      "uuid": "60279fdd-00cd-46d3-840e-7cfc364bf10b",
      "position_reference": "bGj5_Dam1g04qoFpW2s_el",
      "status": "open"
    },
    {
      "uuid": "a47f40ff-6673-4c49-a3d9-1d65866828ce",
      "position_reference": "cKF0d_zNnmsApzhwwgAcJo",
      "status": "open"
    },
    {
      "uuid": "5236a40e-f3de-40ea-b5ec-a3c707cfe532",
      "position_reference": "REF-M-R9J2DWL",
      "status": "open"
    },
    {
      "uuid": "0ea929b2-3188-404c-81c4-fc2f6f76a02e",
      "position_reference": "  cmGLoJIi5b25pjs3fcYqq_",
      "status": "open"
    },
    {
      "uuid": "8e25fd4c-a00b-430a-8e4b-aa8724659f50",
      "position_reference": " cmGLoJIi5b25pjs3fcYqq_",
      "status": "open"
    },
    {
      "uuid": "11421cae-d72a-4848-b224-c00005dad341",
      "position_reference": "REF-4D-LDSPJ1P",
      "status": "open"
    },
    {
      "uuid": "42698021-d0a7-49ce-9d4d-89f2b28c07ad",
      "position_reference": "REF-C-P5MNFAG",
      "status": "open"
    },
    {
      "uuid": "d532219e-abba-4684-8ffb-262cb14eef21",
      "position_reference": "REF-4D-QI8N0EQ",
      "status": "open"
    },
    {
      "uuid": "0213cb7c-6562-4afe-9d3d-60e8ba13cc3a",
      "position_reference": "REF-M-KHA2QTS",
      "status": "open"
    },
    {
      "uuid": "084a3a25-5155-4cb4-9a5a-aeb26f5ff8d6",
      "position_reference": "REF-C-Q4E77QJ",
      "status": "open"
    },
    {
      "uuid": "4e97f28f-7bb4-4a2f-9f22-9eb8827bc68a",
      "position_reference": "REF-M-PR1YBA8",
      "status": "open"
    },
    {
      "uuid": "ae634ec3-1895-4a18-b1b9-0e6a097bf87e",
      "position_reference": "REF-M-K61LYY8",
      "status": "open"
    },
    {
      "uuid": "02a290ce-f882-4f38-a1e1-247aa1e7789d",
      "position_reference": "REF-M-JKLNPHN",
      "status": "open"
    },
    {
      "uuid": "03f15def-5cbd-479d-92c2-09ca23781bb9",
      "position_reference": "REF-4D-OVVC6EY",
      "status": "open"
    },
    {
      "uuid": "ebf404c1-b8ed-48a0-a6d6-47e1477d8771",
      "position_reference": "REF-57-UXDVIHN",
      "status": "open"
    },
    {
      "uuid": "1eac8ac9-f260-4807-b596-696eef616657",
      "position_reference": "REF-4D-J3WBEU3",
      "status": "open"
    },
    {
      "uuid": "5e34fc74-99b1-4b8b-9ba6-07cab3003f41",
      "position_reference": "REF-5A-PDYFMH7",
      "status": "open"
    },
    {
      "uuid": "0c73b2f3-5169-405c-a5b5-5e06d3b39e59",
      "position_reference": "REF-5A-I5F24PL",
      "status": "open"
    },
    {
      "uuid": "fb8b92e0-d344-4465-a8f8-7f8fc1828afe",
      "position_reference": "REF-4D-J7UMTRK",
      "status": "open"
    },
    {
      "uuid": "ac54b34a-f43c-4c40-bb16-6773c5feae32",
      "position_reference": "REF-57-MPI4PDM",
      "status": "open"
    },
    {
      "uuid": "685b0bf2-526a-438e-9f4b-314264fd3df8",
      "position_reference": "REF-5A-QX7Y04I",
      "status": "open"
    },
    {
      "uuid": "43f0a8fa-8b2e-4aee-9d75-bb809d136855",
      "position_reference": "REF-5A-ID2M0QK",
      "status": "open"
    },
    {
      "uuid": "9b146eea-5153-4426-8d48-834cb579182a",
      "position_reference": "REF-4X-SQ85HVZ",
      "status": "open"
    },
    {
      "uuid": "ff0074db-3296-4bf3-8f5d-8f2f635fc705",
      "position_reference": "REF-5A-PWPKPP5",
      "status": "open"
    },
    {
      "uuid": "d15c2a90-03ee-4775-a0c2-cdb7d9da9b13",
      "position_reference": "REF-5A-OR97NNF",
      "status": "open"
    },
    {
      "uuid": "6ec509ed-6bdd-471d-a89f-a3ed7ddf0b0e",
      "position_reference": "REF-7T-PIS5BDH",
      "status": "open"
    },
    {
      "uuid": "7332b9f2-476a-4d6d-95ce-22e454bfe856",
      "position_reference": "REF-5A-QCZ8CS9",
      "status": "open"
    },
    {
      "uuid": "43e416e8-973b-4e96-b8e0-3f968288bf20",
      "position_reference": "REF-8U-FYE4K9W",
      "status": "open"
    },
    {
      "uuid": "090b31db-930d-47c5-a4c4-f18b032c133c",
      "position_reference": "REF-4D-OLSJQ9I",
      "status": "open"
    },
    {
      "uuid": "425797ba-c727-4d34-998e-66f9a48b5de4",
      "position_reference": "REF-57-HWSCHNQ",
      "status": "open"
    },
    {
      "uuid": "a1892405-5ee9-44dc-94dd-a635bd4b1be5",
      "position_reference": "REF-5A-GGUC1OO",
      "status": "open"
    },
    {
      "uuid": "dbf413c8-f51a-42b0-87f6-e76dc8b2630c",
      "position_reference": "REF-5A-H72APAG",
      "status": "open"
    },
    {
      "uuid": "04318712-6849-4ce0-8138-5561da354bfa",
      "position_reference": "REF-5A-HHH38V7",
      "status": "open"
    },
    {
      "uuid": "edaeb800-4a0a-4640-9e22-424492010602",
      "position_reference": "REF-5A-HTDO43N",
      "status": "open"
    },
    {
      "uuid": "1df17bf1-83e6-471d-a905-a85835099cf2",
      "position_reference": "REF-5A-FAY2XZA",
      "status": "open"
    },
    {
      "uuid": "4d4ee379-0f16-4487-901e-ebb37445f16d",
      "position_reference": "REF-4D-GVZ1WAI",
      "status": "open"
    },
    {
      "uuid": "139a7ece-e87d-43cc-819f-16920c8e9625",
      "position_reference": "REF-M-PW0YIFR",
      "status": "open"
    },
    {
      "uuid": "bf81bc90-7350-4e1b-89d5-6ea9c27cdec3",
      "position_reference": "REF-5N-KLBCUFJ",
      "status": "open"
    },
    {
      "uuid": "658f3f53-c061-4604-8f24-cbcca31e6452",
      "position_reference": "REF-5N-LII867G",
      "status": "open"
    },
    {
      "uuid": "f7bcaf78-5dc3-4fa7-91ad-6835d29cc7c1",
      "position_reference": "REF-M-JA7VMQL",
      "status": "open"
    },
    {
      "uuid": "a737463d-4065-4f8f-96f4-d1b89084a543",
      "position_reference": "REF-4X-RD2LQAM",
      "status": "open"
    },
    {
      "uuid": "80d674d7-1af9-4add-a2d8-7dbc69858a70",
      "position_reference": "REF-C-PTMLKLV",
      "status": "open"
    },
    {
      "uuid": "b8898aaf-7c4a-4eb8-ac2f-a0fd73d0d79b",
      "position_reference": "REF-C-TDIEESG",
      "status": "open"
    },
    {
      "uuid": "b2edfde6-6d3a-4f47-bddf-45d9b7947e44",
      "position_reference": "REF-4D-RV9H912",
      "status": "open"
    },
    {
      "uuid": "0bacf83b-498d-4e4b-929f-3d2b19e58077",
      "position_reference": "REF-9T-S9FQE9M",
      "status": "open"
    },
    {
      "uuid": "b3a485da-4c0e-4527-97e0-d84c0dba11d9",
      "position_reference": "REF-5N-JIID7QA",
      "status": "open"
    },
    {
      "uuid": "1d3abf99-68fe-4670-a481-90b570c67803",
      "position_reference": "REF-C-T55AJX1",
      "status": "open"
    },
    {
      "uuid": "c72d292d-f8f0-483d-bbef-e9c4d0f489f3",
      "position_reference": "REF-C-JBMB2CN",
      "status": "open"
    },
    {
      "uuid": "aeb85513-a34b-4e78-8d0e-2ab774869691",
      "position_reference": "REF-C-N3N4DCS",
      "status": "open"
    },
    {
      "uuid": "5d4981db-c371-494f-ae82-45b3322e8a33",
      "position_reference": "REF-5N-OSNGWTL",
      "status": "open"
    },
    {
      "uuid": "55474f79-824d-43f1-96bb-ae20ef804afd",
      "position_reference": "REF-4D-N4E4FTP",
      "status": "open"
    },
    {
      "uuid": "5115d173-160f-4238-b3bf-2927d4b48a7e",
      "position_reference": "REF-C-RCTGJ86",
      "status": "open"
    },
    {
      "uuid": "f32a0a93-e197-415c-8082-f2e7c9e8e1f8",
      "position_reference": "REF-C-HOG2VG8",
      "status": "open"
    }
  ]
}
View

GET /hr_api/v1/position_openings/:uuid

Return details of an existing Position Opening

Params

Property Required Details Location

uuid

Must be a String

 URL

Examples

GET /hr_api/v1/position_openings/:uuid
200
{
  "position_opening": {
    "uuid": "c334fec5-b133-48b0-ac8e-a9b9dbe67ba9",
    "position_reference": "ddnp7fStniSkYoQBNB5NUP",
    "language": null,
    "number_to_fill": 10,
    "status": "open",
    "valid_from": "2010-03-26T00:00:00.000+00:00",
    "valid_to": null,
    "vms_transfer_status": "complete",
    "quota": 100,
    "approval_status": "approved",
    "description": "Description in new description field. test",
    "applications_owner_type": "named_user",
    "transferred_to_vms_at": "2013-11-11T13:45:52.000+00:00",
    "quota_publication_flag": "quota_not_reached",
    "publication_status": "published",
    "quota_auto_republish": true,
    "ni_flag": false,
    "ni_exported": null,
    "ni_salary": null,
    "ni_location": null,
    "ni_advertising_method": null,
    "ni_status": null,
    "ni_department": null,
    "ni_advertisment_type": null,
    "ni_apprentice_flag": null,
    "auto_fill": false,
    "enable_alerts": false,
    "position_opening_template": {
      "uuid": "e7ac39ac-9eb6-49a8-a10e-78694fd27114",
      "title": "Store Manager - UK",
      "language": null,
      "number_to_fill": 1,
      "quota": 10,
      "distribution_types": [
        "external"
      ],
      "body": "<p>UK Store manager vacancy template text.</p>",
      "data": null,
      "description": null,
      "applications_owner_type": "any_named_user",
      "status": "active",
      "quota_auto_republish": "",
      "default_position_detail_title": "",
      "default_remuneration_package_title": null,
      "position_form_options": {},
      "auto_fill_type": "never_auto_fill",
      "use_remuneration_package_keyword": false,
      "use_shift_keyword": false,
      "restricted_access": false,
      "use_job_category_one": true,
      "use_job_category_two": true,
      "use_job_category_three": true,
      "use_contract_type": true,
      "position_openings_owner_type": "any_named_user",
      "system_flags": 0,
      "encoded_body": "&lt;p&gt;UK Store manager vacancy template text.&lt;/p&gt;",
      "user_group_names": null,
      "publication_scope_templates": [
        {
          "name": "external",
          "system_flags": 0
        }
      ]
    },
    "configuration_scope": {
      "uuid": "1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28",
      "scope_type": "recruitment",
      "sort": 10,
      "name": "recruitment",
      "category_status": "active",
      "title": "Recruitment"
    }
  }
}