What This API Endpoint Does

With the Users API you can get a list of all users in your Rise account as well as the details of a single user.

Endpoints

GET /users - list users
GET /users/{userId} - get details of a user by user id

User Object

id (string) - the unique identifier of the user
email (string) - the user's email address
groupsUrl (string) - URL to list user's groups from the API
reportingGroupsUrl (string) - URL to list groups the user is a reporter for from the API (note: only set when user has a role of reporter)
role (string) - the user's role (one of learner, author, reporter, or admin)
firstName (string) - the user's first name
lastName (string) - the user's last name
lastActiveAt (string) - the date and time of the user's last activity in rise
learnerReportUrl (string) - URL to fetch the user's learner report from the API
favoritesUrl (string) - URL to fetch the user's favorites list from the API
url (string) - URL to fetch user's details from the API

Retrieving a List of Users

`GET /users`

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)
email (string, optional) - if provided, only return users with this email address

Example Response

{ 
 "users": [ 
   { 
    "id": "example-user-id-1", 
    "email": "foo@example.com", 
    "groupsUrl": "https://api.rise.com/users/example-user-id-1/groups", 
    "reportingGroupsUrl": "https://api.rise.com/users/example-user-id-1/reportingGroups/", 
    "role": "reporter", 
    "firstName": "Example First Name 1", 
    "lastName": "Example Last Name 1", 
    "lastActiveAt": "2021-10-28T20:39:52.659Z",
    "learnerReportUrl": "https://api.rise.com/reports/learners/example-user-id-1", 
    "favoritesUrl": "https://api.rise.com/users/example-user-id-1/favorites",
    "url": "https://api.rise.com/users/example-user-id-1"
   }, ... 
 ], 
 "nextUrl": "https://url-for-next-page-of-results" 
}

Retrieving Specific User Details

`GET /users/{userId}`

Example Response

{ 
  "id": "example-user-id", 
  "email": "example@example.com", 
  "groupsUrl": "https://api.rise.com/users/example-user-id-1/groups", 
  "reportingGroupsUrl": "https://api.rise.com/users/example-user-id-1/reportingGroups/", 
  "role": "reporter", 
  "firstName": "Example First Name", 
  "lastName": "Example Last Name", 
  "lastActiveAt": "2021-10-28T20:39:52.659Z",
  "learnerReportUrl": "https://api.rise.com/reports/learners/example-user-id", 
  "favoritesUrl": "https://api.rise.com/users/example-user-id/favorites",
  "url": "https://api.rise.com/users/example-user-id" 
}

Endpoint-specific Error Codes

user_not_found - cannot retrieve user because user does not exist