What This API Endpoint Does

With the Courses API you can get a list of all submitted courses (published and unpublished) in your Reach 360 account as well as the details of a single course.

• Endpoints
• Course Object
• List Courses
• Retrieve Course by ID

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
• contentType (string) - type of course (can be one of: MICROLEARNING, STORYLINE, IMPORTED, RISE)

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)
• contentType (string, optional) - Filter response to a specific Content Type. Available options are rise, storyline, microlearning, imported, all

Example Response

{ 
 "courses": [ 
  { 
   "id": "example-course-id-1", 
   "title": "Course Title", 
   "coverImageUrl": null, 
   "authorUrl": "https://api.reach360.com/users/author-user-id", 
   "courseReportUrl": "https://api.reach360.com/reports/courses/example-course-id-1", 
   "url": "https://api.reach360.com/courses/example-course-id-1" 
   "contentType": "RISE"
  }, ... 
 ], 
 "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.reach360.com/users/author-user-id", 
 "courseReportUrl": "https://api.reach360.com/reports/courses/example-course-id", 
 "url": "https://api.reach360.com/courses/example-course-id" 
 "contentType": "RISE"
}

Endpoint-specific error codes

• course_not_found - cannot retrieve course because course does not exist