What This API Endpoint Does

With the Learning Paths API you can get a list of all learning paths in your Rise account as well as the details of a single learning path and the courses that make up a learning path.

Endpoints

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 Object

id (string) - the unique identifier of the learning path
title (string) - title of the learning path
description (string) - description of the learning path
coverImageUrl (string) - URL for the learning path cover image (if any)
coursesUrl (string) - URL to fetch the list of courses in the learning path from the API
coursesReportUrl (string) - URL to fetch the learning path courses report from the API
learnersReportUrl (string) - URL to fetch the learning path learners report from the API
url (string) - URL to fetch the learning path's details from the API

Learning Path 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
source (string) - The source of the course. Returns one of team (Team Content), rise (Rise Content), or nbic (Next Big Idea Club)
order (integer) - order of a course in a learning path (numbering starts at 0)

List Learning Paths

`GET /learning-paths`

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

{ 
 "learningPaths": [ 
   { 
    "id": "example-learning-path-1", 
    "title": "Learning Path Title", 
    "description": "A simple learning path", 
    "coverImageUrl": null, 
    "coursesUrl": "https://api.rise.com/learning-paths/example-learning-path-1/courses", 
    "coursesReportUrl": "https://api.rise.com/reports/learning-paths/example-learning-path-1/courses", 
    "learnersReportUrl": "https://api.rise.com/reports/learning-paths/example-learning-path-1/learners", 
    "url": "https://api.rise.com/learning-paths/example-learning-path-1" 
   }, ... 
 ], 
 "nextUrl": "https://url-for-next-page-of-results" 
}

Retrieve Learning Path by ID

`GET /learning-paths/{learningPathId}`

Example Response

{ 
  "id": "example-learning-path", 
  "title": "Learning Path Title", 
  "description": "A simple learning path", 
  "coverImageUrl": null, 
  "coursesUrl": "https://api.rise.com/learning-paths/example-learning-path/courses", 
  "coursesReportUrl": "https://api.rise.com/reports/learning-paths/example-learning-path/courses", 
  "learnersReportUrl": "https://api.rise.com/reports/learning-paths/example-learning-path/learners", 
  "url": "https://api.rise.com/learning-paths/example-learning-path" 
}

Endpoint-specific error codes

learning_path_not_found - cannot retrieve learning path because learning path does not exist

List Courses in Learning Path

`GET /learning-paths/{learningPathId}/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

{ 
  "learningPathUrl": "https://api.rise.com/learning-paths/example-learning-path-id-1", 
  "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" 
    "order": 3
  }, ... 
 ], 
 "nextUrl": "https://url-for-next-page-of-results" 
}

Endpoint-specific error codes

learning_path_not_found - cannot list courses because learning path does not exist