Skip to main content
All CollectionsRise API and IntegrationsREST API
Endpoints Reference Guide
Endpoints Reference Guide

Summary of all Rise API endpoints

Anthony Karcz avatar
Written by Anthony Karcz
Updated over 2 years ago

Courses API

  • GET /courses - list courses

  • GET /courses/{courseId} - get details of a course by course id

Course Enrollment API

  • PUT /courses/{courseId}/users/{userId} - enroll a single user in a course

  • PUT /courses/{courseId}/groups/{groupId} - enroll a group of users in a course

  • DELETE /courses/{courseId}/users/{userId} - unenroll a single user from a course

  • DELETE /courses/{courseId}/groups/{groupId} - unenroll a group of users from a course

Favorites API

  • GET /users/{userId}/favorites - list courses and learning paths in a user's Favorites

Groups API

  • POST /groups - create a new group

  • GET /groups - list groups

  • GET /groups/{groupId} - get details of a group by group id

  • PUT /groups/{groupId} - update a group by group id

  • DELETE /groups/{groupId} - delete a group by group id

Group Memberships API

  • GET /groups/{groupId}/users - list a group's members

  • GET /users/{userId}/groups - list a user's groups

  • PUT /groups/{groupId}/users/{userId} - add a user to a group

  • DELETE /groups/{groupId}/users/{userId} - remove a user from a group

Import Course Completion API

  • POST /courses/{courseId}/users/{userId}/completions - import completion data for a single course/user pair into Rise.

Invitations API

  • POST /invitations—send an invitation to a user to join your team

  • GET /invitations—list pending invitations

  • GET /invitations/{invitationId}—get details of a pending invitation by invitation id

  • DELETE /invitations/{invitationId}—delete a pending invitation by invitation id

Learning Paths API

  • GET /learning-paths - list learning paths

  • GET /learning-paths/{learningPathId} - get details of a learning path by learning path id

  • GET /learning-paths/{learningPathId}/courses - list courses in a learning path by learning path id

Learning Path Enrollments API

  • PUT /learning-paths/{learningPathId}/users/{userId} - enroll a single user in a learning path

  • PUT /learning-paths/{learningPathId}/groups/{groupId} - enroll a group of users in a learning path

  • DELETE /learning-paths/{learningPathId}/users/{userId} - unenroll a single user from a learning path

  • DELETE /learning-paths/{learningPathId}/groups/{groupId} - unenroll a group of users from a learning path

Reports API

  • GET /reports/activity - user activity report (list of user sessions)

  • GET /reports/courses/{courseId} - course learner report (list of learner sessions for a course)

  • GET /reports/learners/{userId} - learner course report (list of course sessions for a learner)

  • GET /reports/learning-paths/{learningPathId}/courses - learning path courses report (list of course sessions in a learning path)

  • GET /reports/learning-paths/{learningPathId}/learners - learning path learners report (list of learner sessions in a learning path)

Reporters and Reporting Groups API

  • GET /users/{userId}/reporting-groups - list what groups a reporter reports for

  • GET /groups/{groupId}/reporters - list a group's reporters

  • PUT /groups/{groupId}/reporters/{userId} - add a reporter for a group

  • DELETE /groups/{groupId}/reporters/{userId} - remove a reporter for a group

Users API

  • GET /users - list users

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

Webhooks API

  • POST /webhooks - create a new webhook

  • GET /webhooks - list webhooks

  • GET /webhooks/{webhookId} - get details of a webhook by webhook id

  • DELETE /webhooks/{webhookId} - delete a webhook by webhook id

Did this answer your question?