v1

latestOpenAPI 3.0.22026-07-26191278525.6 KB
Course

Get Course

Given a course id of a course, it returns the course object

get/api/v2/core/courses/{courseId}

Path parameters

courseIdstring required

ID of course in Eightfold

Query parameters

excludestring

Exclude specific fields in the response. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

keyListstring

Allows selective control over the fields returned in the API response. If the keyList is empty, all fields will be returned. Possible values are the names of the top level fields present in corresponding API schema. To check API schema, expand the response section below.

Headers

Authorizationstring required

The secret key to access the api. It starts with the bearer token

Response

OK

courseIdstring nullable

ID of the course

skillsstring[] nullable

skills related to course

groupIdstring nullable

Group id of the course

durationHoursnumber float nullable

Duration hours of course

categorystring nullable

course category

imageUrlstring nullable

image url of course

systemIdstring nullable

System id for the course

courseTypestring nullable

course type

difficultystring nullable

Difficulty of course

courseUrlstring nullable

url of the course

titlestring nullable

title of course

ratingCountinteger nullable

Number of ratings submitted for the course

ratingnumber float nullable

Average rating of the course

lmsCourseIdstring nullable

lms course id

languagestring nullable

language

efSkillsstring[] nullable

Eightfold-detected course skills based on title and description

statusstring nullable

status of course

providerstring nullable

provider of course

publishedDatestring nullable

Publication date of course

descriptionstring nullable

Description of course