Reach 360: Managers and Managing Groups API

Endpoints

• GET /users/{userId}/managing-groups - list what groups a manager manages
• GET /groups/{groupId}/managers - list a group's managers

List Groups a Manager Manages

GET /users/{userId}/managing-groups

Request Parameters (Query String)

• limit (integer, optional) - the maximum number of results to return in a single response (see Pagination); must be between 1 and 100 (defaults to 50)

Example Response

{
  "userUrl": "<https://api.rise.com/users/example-user-id-1>",
  "groups": [
    {
      "id": "example-group-id-1",
      "membersUrl": "<https://api.rise.com/groups/example-group-id-1/users>",
      "managersUrl": "<https://api.rise.com/groups/example-group-id-1/managers>",
      "reportersUrl": "<https://api.rise.com/groups/example-group-id-1/reporters>",
      "name": "Example Group",
      "url": "<https://api.rise.com/groups/example-group-id-1>"
    }, ...
  ],
  "nextUrl": "<https://url-for-next-page-of-results>"
}

Endpoint-specific error codes:

• user_not_found - can't list manager’s groups because user doesn't exist
• invalid_user_role - can't list manager's groups because user isn't a manager

List a Group's Managers

GET /groups/{groupId}/managers

Request Parameters (Query String)

• limit (integer, optional) - the maximum number of results to return in a single response (see Pagination); must be between 1 and 100 (defaults to 50)

Example Response

{
  "groupUrl": "<http://api.rise.com/groups/example-group-id>",
  "managers": [
    {
      "id": "example-user-id-1",
      "email": "foo@example.com",
      "groupsUrl": "<https://api.rise.com/users/example-user-id-1/groups>",
      "managingGroupsUrl": "<https://api.rise.com/users/example-user-id-1/managing-groups>",
      "reportingGroupsUrl": null,
      "role" :"manager",
      "firstName": "Example Group Manager",
      "lastName": "Example Last Name",
      "lastActiveAt": "2021-10-28T20:39:52.659Z",
      "learnerReportUrl": "<https://api.rise.com/reports/learners/example-user-id-1>",
      "url": "<https://api.rise.com/users/example-user-id-1>"
    },
    {
      "id": "example-user-id-2",
      "email": "bar@example.com",
      "groupsUrl": "<https://api.rise.com/users/example-user-id-2/groups>",
      "managingGroupsUrl": "<https://api.rise.com/users/example-user-id-2/managing-groups>",
			"reportingGroupsUrl": null,
      "role": "manager",
      "firstName": "Example Group Manager 2",
      "lastName": "Example Last Name",
      "lastActiveAt": "2021-10-28T20:39:52.659Z",
      "learnerReportUrl": "<https://api.rise.com/reports/learners/example-user-id-2>",
      "url": "<https://api.rise.com/users/example-user-id-2>"
    }, ...
  ],
  "nextUrl": "<https://url-for-next-page-of-results>"
}

Endpoint-specific error codes:

• group_not_found - can't list managers because group doesn't exist