What This API Endpoint Does
With the Courses API you can get a list of all submitted courses (published and unpublished) in your Rise account as well as the details of a single course.
Endpoints
GET /courses
- list coursesGET /courses/{courseId}
- get details of a course by course id
Course object
id
(string) - the unique identifier of the coursetitle
(string) - title of the coursecoverImageUrl
(string) - URL for course cover image (if any)authorUrl
(string) - URL to fetch author's user details from the APIcourseReportUrl
(string) - URL to fetch course report from the APIurl
(string) - URL to fetch course's details from the APIsource
(string) - The source of the course. Returns one of team (Team Content), rise (Rise Content), or nbic (Next Big Idea Club)
List Courses
GET /courses
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)source
(string, optional) - Restrict results to a specific source. Available options are all, team, nbic, and rise.
Example Response
{
"courses": [
{
"id": "example-course-id-1",
"title": "Course Title",
"coverImageUrl": null,
"authorUrl": "https://api.rise.com/users/author-user-id",
"courseReportUrl": "https://api.rise.com/reports/courses/example-course-id-1",
"url": "https://api.rise.com/courses/example-course-id-1"
"source": "team"
}, ...
],
"nextUrl": "https://url-for-next-page-of-results"
}
Retrieve Course by ID
GET /courses/{courseId}
Example Response
{
"id": "example-course-id",
"title": "Course Title",
"coverImageUrl": null,
"authorUrl": "https://api.rise.com/users/author-user-id",
"courseReportUrl": "https://api.rise.com/reports/courses/example-course-id",
"url": "https://api.rise.com/courses/example-course-id"
"source": "team"
}
Endpoint-specific error codes
course_not_found
- cannot retrieve course because course does not exist