User Groups

Supported Formats: json
View

GET /hr_api/v1/user_groups

Returns a list of User Groups

Params

Property Required Details Location

page

Index returns 100 records per request. Defaults to 1.

Must be a Integer

 URL

Examples

GET /hr_api/v1/user_groups
200
{
  "user_groups": [
    {
      "uuid": "a63a9159-ef32-4ee5-a399-f76e0e61ffd7",
      "name": "Super Users"
    },
    {
      "uuid": "4a6ebe97-ed77-4f06-982c-b1bf05732cbc",
      "name": "Recruiters"
    },
    {
      "uuid": "bb53e888-3b2b-4966-be46-0605b1008a19",
      "name": "Interviewers"
    },
    {
      "uuid": "c4123ab5-736e-462e-adec-5bcd23bd3d93",
      "name": "Mike Interviewer Delegation"
    },
    {
      "uuid": "bdffce8f-6384-4578-8680-88b7078e919f",
      "name": "Mike Peter Mutual Delegation"
    },
    {
      "uuid": "cbcb97d6-8035-4e3e-a448-1a72d190490e",
      "name": "Peter delegate to Mike"
    },
    {
      "uuid": "f1403ea2-16ea-46a5-879d-37963c22becc",
      "name": "Delegate all"
    },
    {
      "uuid": "d35de876-a1fb-4cb2-96b1-6aa490c5b324",
      "name": "DB Admin"
    },
    {
      "uuid": "fb8b42ca-d5f6-4152-b81e-779361664fd3",
      "name": "Northern Ireland Users"
    },
    {
      "uuid": "f0dbe85f-8942-41c2-b94b-21f6f08a0495",
      "name": "Superuser Mike delegation"
    },
    {
      "uuid": "ef2fa724-a71b-4b9c-8eef-d99a73338dd7",
      "name": "Hiring Managers"
    },
    {
      "uuid": "890e21dd-47a4-4183-b7c4-99071aa9a71e",
      "name": "Mike Hiring Manager Delegation"
    },
    {
      "uuid": "d66416a4-c27b-4b2a-aaa4-cca34f57102c",
      "name": "Recruiter Delegation"
    },
    {
      "uuid": "b67ff521-517c-4ed8-a70c-4561a89e728e",
      "name": "Recruitment Guests"
    },
    {
      "uuid": "7da10d7a-e1ba-423f-bbb4-dc5bb94285d4",
      "name": "Recruitment Guest Delegation"
    },
    {
      "uuid": "b16f33bc-6208-4375-80c7-3d78136dd95f",
      "name": "Test DG"
    },
    {
      "uuid": "3f0c6dab-10cf-4284-9aa3-9f35f89ba669",
      "name": "Employee Users"
    },
    {
      "uuid": "785f565c-6996-4bd2-9720-d325a56d3fd5",
      "name": "Employee Dlegation"
    },
    {
      "uuid": "27fe81cf-9aee-400e-9117-e7f9e0a64a5b",
      "name": "Employee Admin Users"
    },
    {
      "uuid": "56da41c4-63d1-4ebb-8843-4be8ce831131",
      "name": "Employee Admin Delegation"
    },
    {
      "uuid": "8c4a5af2-262c-4eed-baa6-cdfb0b55300c",
      "name": "Test user group"
    },
    {
      "uuid": "83de7560-82d2-4fae-b764-9d1ed23c176a",
      "name": "Test DG 2"
    },
    {
      "uuid": "65b22618-7f31-4383-953f-ae654efecd8c",
      "name": "Agencies"
    },
    {
      "uuid": "a23f82a7-df4f-45df-a72d-b2122fc02577",
      "name": "DB Admin to Agency Delegation"
    },
    {
      "uuid": "eae1ec61-932e-4cea-87e3-795f6f65b6af",
      "name": "Agency DB Admins"
    },
    {
      "uuid": "438c2700-67e4-45e2-85b3-fbab9efdd73b",
      "name": "CO Recruiters"
    },
    {
      "uuid": "fc1157c7-90c0-4608-9393-2db564478e09",
      "name": "CO Superusers"
    },
    {
      "uuid": "2b093d75-1e3b-4077-a490-0f22775998ae",
      "name": "CO Hiring Manager"
    },
    {
      "uuid": "be9f47b9-8c95-404a-b1de-bbd4ce67487d",
      "name": "CO Superuser Delegation"
    },
    {
      "uuid": "c6102523-4cca-474f-9643-512073f4fce4",
      "name": "CO Recruiter Delegation"
    },
    {
      "uuid": "3299d1d8-dd62-43f6-a5d2-9f38a15e0576",
      "name": "London Office"
    },
    {
      "uuid": "90e4ae29-ae80-4970-b177-b48971a91275",
      "name": "Henley Office"
    },
    {
      "uuid": "98bc54e9-3512-4036-b33e-9e5281603df4",
      "name": "TSE Users"
    },
    {
      "uuid": "a0947bc5-5d12-4584-b439-e98aab2af609",
      "name": "Test Delegation"
    },
    {
      "uuid": "d5aaf5da-86bb-4974-b8bd-71668b81544c",
      "name": "testgroup"
    },
    {
      "uuid": "9beb2eb0-b19a-4f17-b3cb-e7445bcf58a5",
      "name": "Approvers"
    },
    {
      "uuid": "9dc14687-4ad1-4eed-8b38-15aea2cd131b",
      "name": "Hiring Manager delegation"
    },
    {
      "uuid": "f6147f65-761a-43cb-a62a-90dd7b72d3da",
      "name": "Hiring Manager delegation"
    },
    {
      "uuid": "3960d431-5806-46d0-854b-58e9018e2fd7",
      "name": "Custom Questionnaire Users"
    },
    {
      "uuid": "57d57f94-d16a-4a8d-877f-3d2517005335",
      "name": "Requisition Users"
    },
    {
      "uuid": "c88b1ceb-5213-4965-bacf-bfe843a964a9",
      "name": "Requisition Admins"
    },
    {
      "uuid": "704c5718-2200-44be-86a2-8bb63b9b8478",
      "name": "Rails 4 test group"
    },
    {
      "uuid": "eb198753-de8e-4174-b700-5861e2948940",
      "name": "Talent Pool users"
    },
    {
      "uuid": "dce97c65-33b9-434a-b981-5cf4778523d8",
      "name": "API Recruiter"
    }
  ]
}
View

GET /hr_api/v1/user_groups/:uuid

Return details of an existing User Group

Params

Property Required Details Location

uuid

Must be a String

 URL

Examples

GET /hr_api/v1/user_groups/:uuid
200
{
  "user_group": {
    "uuid": "a63a9159-ef32-4ee5-a399-f76e0e61ffd7",
    "name": "Super Users",
    "description": "",
    "group_type": "access_role",
    "sys_admin": false,
    "configuration_scope": {
      "uuid": "1a213dd2-4eaa-4e4b-a38d-05e6e21e5d28",
      "name": "recruitment",
      "category_status": "active"
    }
  }
}