---
title: "Retrieve information about a course by id"
slug: "retrieve-information-about-a-course-by-id"
updated: 2024-10-25T18:04:27Z
published: 2026-02-10T22:32:35Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.skillable.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve information about a course by id

Get/GetCourse/{id}

Allows you to get information about a course.

SecurityAPI Key: api_keyHeader parameter nameapi_key

Path parametersidinteger (int32) Required

The ID of the course to retrieve

Example34556

Responses200

OK Response

<select class='api-response-data' aria-label='Media type'><option value='87917db6-8fce-4c9f-929d-672a92e99dc8'>application/json</option>
</select>Expand Allobject  Statusinteger  (int32)    

Indicates the status of the API request.

0 = Success 10 = Error 20 = Not found 30 = Invalid integration key

Example10
Errorstring   | null  

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

Courseobject (Course)  Idinteger  (int32)    

The course's unique identifier

Example5678
ExternalIdstring   | null  

The course's external ID, usually a unique identifier from the calling system

Examplece2637fc-7eac-43d1-9e75-565e9f7ff53b
Namestring    

The Name of the course

ExampleA Course Name
Descriptionstring   | null  

The description of the course

ExampleA course description
HtmlDescriptionstring   | null  

The HTML description of the course

Example<p>Some HTML Description</p>
AvailableInstructorLedboolean    

The setting for if this course is available to be delivered in an instructor-led format

Exampletrue
AvailableSelfPacedboolean    

The setting for if this course is available to be delivered in a self-paced format

Exampletrue
OrganizationIdinteger  (int32)   | null  

The Id of the owning organization for this course

Example345
OrganizationNamestring   | null  

The name of the owning organization for this course

ExampleOrganization Name Sample
ContentProviderIdinteger  (int32)   | null  

The Id of the content provider for this course (if any)

Example123
ContentProviderNamestring   | null  

The name of the content provider for this course (if any)

ExampleContent Prvider Name Sample
Activities Array of object (Activity)   

See Activity.

object  Idinteger  (int32)    

The activity's unique identifier

Example33345
ParentIdinteger  (int32)   | null  

The Id of the activity's parent activity (if any)

ActivityIdinteger  (int32)    

The internal Id of the activity.

Example29119
ActivityTypeIdinteger  (int32)    

The Id of the activity type:

- ScormModule = 2
- Lab = 4
- Survey = 10
- InstructorSurvey = 20
- OrganizationSurvey = 30
- ExternalLink = 40
- Assessment = 50
- Video = 60
- Document = 70 -
Section = 80

Example4
ActivityTypeNamestring    

The activity's type name

ExampleLab
Namestring    

The activity's name

ExampleActivity Name Sample
Descriptionstring   | null  

The activity's description

ExampleActivity description sample
Subtitlestring   | null  

The activity's subtitle

AllowRetakeboolean    

The activity's setting to allow retakes

Exampletrue
AllowReviewboolean    

The activity's setting to allow review

Examplefalse
Urlstring   | null  

The activity's url

SortOrderinteger  (int32)    

The activity's sort order index

Example0
Requiredboolean    

The activity's setting for if the activity is required for course completion

Exampletrue
AvailabilityTypeIdinteger  (int32)    

The activity's availablility type id

- Everyone = 0
- Instructors Only = 1

Example0
ExpectedDurationSecondsinteger  (int32)    

The activity's expected duration in seconds

Example3540
IsExamboolean    

The activity's setting as a scored lab (This only applies to Lab type activities)

Examplefalse
Activities Array of object (Activity)   

See Activity.

object Recursive  

Durationnumber  (float)    

The course's duration.

Example144.5
DurationUnitIdinteger  (int32)    

The course's duration type identification. Values include:

- Minutes = 0
- Hours = 1
- Days = 2
- Weeks = 3

Example2
Tags Array of object (Tag)   

See Tag.

object  Idinteger  (int32)    

The tag's unique identifier.

Example2
Namestring   | null  

The tag's name.

ExampleTag Example 1

CustomFields Array of object (CustomField)   

See CustomField

object  Namestring    

The name of the custom field.

ExampleMyCustomText
TexValuestring    

The value of the custom field.

ExampleWoohoo!

Createdinteger  (int64)    

When the course was created. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.

Example1449496800
LastModifiedinteger  (int64)    

the course was last modified. Provided in Unix epoch format, which is the number of seconds that have elapsed since midnight UTC January 1st, 1970.

Example1584035120
