Endpoints

  • GET /courses - list courses

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

Course object

  • id (string) - the unique identifier of the course

  • title (string) - title of the course

  • coverImageUrl (string) - URL for course cover image (if any)

  • authorUrl (string) - URL to fetch author's user details from the API

  • courseReportUrl (string) - URL to fetch course report from the API

  • url (string) - URL to fetch course's details from the API

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)

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"
}, ...
],
"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"
}

Endpoint-specific error codes

  • course_not_found - cannot retrieve course because course does not exist

Did this answer your question?