Ctrlk
Shift iQ
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Courses API: Courses

Retrieves one specific course

get
Authorizations
BearerstringRequired
Path parameters
coursestring · uuidRequired
Responses
200

OK

CatalogIdstring · uuid · nullableOptional
CompletedToAdministratorMessageIdstring · uuid · nullableOptional
CompletedToLearnerMessageIdstring · uuid · nullableOptional
CompletionActivityIdstring · uuid · nullableOptional
CourseIdstring · uuidOptional
CreatedBystring · uuidOptional
FrameworkStandardIdstring · uuid · nullableOptional
GradebookIdstring · uuid · nullableOptional
ModifiedBystring · uuidOptional
SourceIdstring · uuid · nullableOptional
StalledToAdministratorMessageIdstring · uuid · nullableOptional
StalledToLearnerMessageIdstring · uuid · nullableOptional
AllowDiscussionbooleanOptional
CourseIsHiddenbooleanOptional
IsDisplayOverviewOnlybooleanOptional
IsMultipleUnitsEnabledbooleanOptional
IsProgressReportEnabledbooleanOptional
CourseCodestring · nullableOptional
CourseDescriptionstring · nullableOptional
CourseFlagColorstring · nullableOptional
CourseFlagTextstring · nullableOptional
CourseHookstring · nullableOptional
CourseIconstring · nullableOptional
CourseImagestring · nullableOptional
CourseLabelstring · nullableOptional
CourseLevelstring · nullableOptional
CourseNamestring · nullableOptional
CoursePlatformstring · nullableOptional
CourseProgramstring · nullableOptional
CourseSlugstring · nullableOptional
CourseStylestring · nullableOptional
CourseUnitstring · nullableOptional
CourseAssetinteger · int32Optional
CourseSequenceinteger · int32 · nullableOptional
OutlineWidthinteger · int32 · nullableOptional
SendMessageStalledAfterDaysinteger · int32 · nullableOptional
SendMessageStalledMaxCountinteger · int32 · nullableOptional
Closedstring · date-time · nullableOptional
Createdstring · date-timeOptional
Modifiedstring · date-timeOptional
get/api/courses/{course}
GET /v2/e01/api/courses/{course} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

{
  "CatalogId": "123e4567-e89b-12d3-a456-426614174000",
  "CompletedToAdministratorMessageId": "123e4567-e89b-12d3-a456-426614174000",
  "CompletedToLearnerMessageId": "123e4567-e89b-12d3-a456-426614174000",
  "CompletionActivityId": "123e4567-e89b-12d3-a456-426614174000",
  "CourseId": "123e4567-e89b-12d3-a456-426614174000",
  "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
  "FrameworkStandardId": "123e4567-e89b-12d3-a456-426614174000",
  "GradebookId": "123e4567-e89b-12d3-a456-426614174000",
  "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
  "SourceId": "123e4567-e89b-12d3-a456-426614174000",
  "StalledToAdministratorMessageId": "123e4567-e89b-12d3-a456-426614174000",
  "StalledToLearnerMessageId": "123e4567-e89b-12d3-a456-426614174000",
  "AllowDiscussion": true,
  "CourseIsHidden": true,
  "IsDisplayOverviewOnly": true,
  "IsMultipleUnitsEnabled": true,
  "IsProgressReportEnabled": true,
  "CourseCode": "text",
  "CourseDescription": "text",
  "CourseFlagColor": "text",
  "CourseFlagText": "text",
  "CourseHook": "text",
  "CourseIcon": "text",
  "CourseImage": "text",
  "CourseLabel": "text",
  "CourseLevel": "text",
  "CourseName": "text",
  "CoursePlatform": "text",
  "CourseProgram": "text",
  "CourseSlug": "text",
  "CourseStyle": "text",
  "CourseUnit": "text",
  "CourseAsset": 1,
  "CourseSequence": 1,
  "OutlineWidth": 1,
  "SendMessageStalledAfterDays": 1,
  "SendMessageStalledMaxCount": 1,
  "Closed": "2026-01-01T00:00:00.000Z",
  "Created": "2026-01-01T00:00:00.000Z",
  "Modified": "2026-01-01T00:00:00.000Z"
}

Checks for the existence of one specific course

head
Authorizations
BearerstringRequired
Path parameters
coursestring · uuidRequired
Responses
200

OK

No content
head/api/courses/{course}
HEAD /v2/e01/api/courses/{course} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

No content

Collects the list of courses that match specific criteria

post
Authorizations
BearerstringRequired
Body
ClosedSincestring · date-time · nullableOptional
ClosedBeforestring · date-time · nullableOptional
CreatedSincestring · date-time · nullableOptional
CreatedBeforestring · date-time · nullableOptional
ModifiedSincestring · date-time · nullableOptional
ModifiedBeforestring · date-time · nullableOptional
IsPublishedboolean · nullableOptional
Responses
200

OK

CatalogIdstring · uuid · nullableOptional
CompletedToAdministratorMessageIdstring · uuid · nullableOptional
CompletedToLearnerMessageIdstring · uuid · nullableOptional
CompletionActivityIdstring · uuid · nullableOptional
CourseIdstring · uuidOptional
CreatedBystring · uuidOptional
FrameworkStandardIdstring · uuid · nullableOptional
GradebookIdstring · uuid · nullableOptional
ModifiedBystring · uuidOptional
SourceIdstring · uuid · nullableOptional
StalledToAdministratorMessageIdstring · uuid · nullableOptional
StalledToLearnerMessageIdstring · uuid · nullableOptional
AllowDiscussionbooleanOptional
CourseIsHiddenbooleanOptional
IsDisplayOverviewOnlybooleanOptional
IsMultipleUnitsEnabledbooleanOptional
IsProgressReportEnabledbooleanOptional
CourseCodestring · nullableOptional
CourseDescriptionstring · nullableOptional
CourseFlagColorstring · nullableOptional
CourseFlagTextstring · nullableOptional
CourseHookstring · nullableOptional
CourseIconstring · nullableOptional
CourseImagestring · nullableOptional
CourseLabelstring · nullableOptional
CourseLevelstring · nullableOptional
CourseNamestring · nullableOptional
CoursePlatformstring · nullableOptional
CourseProgramstring · nullableOptional
CourseSlugstring · nullableOptional
CourseStylestring · nullableOptional
CourseUnitstring · nullableOptional
CourseAssetinteger · int32Optional
CourseSequenceinteger · int32 · nullableOptional
OutlineWidthinteger · int32 · nullableOptional
SendMessageStalledAfterDaysinteger · int32 · nullableOptional
SendMessageStalledMaxCountinteger · int32 · nullableOptional
Closedstring · date-time · nullableOptional
Createdstring · date-timeOptional
Modifiedstring · date-timeOptional
post/api/courses/collect
POST /v2/e01/api/courses/collect HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 275

{
  "ClosedSince": "2026-01-01T00:00:00.000Z",
  "ClosedBefore": "2026-01-01T00:00:00.000Z",
  "CreatedSince": "2026-01-01T00:00:00.000Z",
  "CreatedBefore": "2026-01-01T00:00:00.000Z",
  "ModifiedSince": "2026-01-01T00:00:00.000Z",
  "ModifiedBefore": "2026-01-01T00:00:00.000Z",
  "IsPublished": true
}
200

OK

[
  {
    "CatalogId": "123e4567-e89b-12d3-a456-426614174000",
    "CompletedToAdministratorMessageId": "123e4567-e89b-12d3-a456-426614174000",
    "CompletedToLearnerMessageId": "123e4567-e89b-12d3-a456-426614174000",
    "CompletionActivityId": "123e4567-e89b-12d3-a456-426614174000",
    "CourseId": "123e4567-e89b-12d3-a456-426614174000",
    "CreatedBy": "123e4567-e89b-12d3-a456-426614174000",
    "FrameworkStandardId": "123e4567-e89b-12d3-a456-426614174000",
    "GradebookId": "123e4567-e89b-12d3-a456-426614174000",
    "ModifiedBy": "123e4567-e89b-12d3-a456-426614174000",
    "SourceId": "123e4567-e89b-12d3-a456-426614174000",
    "StalledToAdministratorMessageId": "123e4567-e89b-12d3-a456-426614174000",
    "StalledToLearnerMessageId": "123e4567-e89b-12d3-a456-426614174000",
    "AllowDiscussion": true,
    "CourseIsHidden": true,
    "IsDisplayOverviewOnly": true,
    "IsMultipleUnitsEnabled": true,
    "IsProgressReportEnabled": true,
    "CourseCode": "text",
    "CourseDescription": "text",
    "CourseFlagColor": "text",
    "CourseFlagText": "text",
    "CourseHook": "text",
    "CourseIcon": "text",
    "CourseImage": "text",
    "CourseLabel": "text",
    "CourseLevel": "text",
    "CourseName": "text",
    "CoursePlatform": "text",
    "CourseProgram": "text",
    "CourseSlug": "text",
    "CourseStyle": "text",
    "CourseUnit": "text",
    "CourseAsset": 1,
    "CourseSequence": 1,
    "OutlineWidth": 1,
    "SendMessageStalledAfterDays": 1,
    "SendMessageStalledMaxCount": 1,
    "Closed": "2026-01-01T00:00:00.000Z",
    "Created": "2026-01-01T00:00:00.000Z",
    "Modified": "2026-01-01T00:00:00.000Z"
  }
]

Counts the courses that match specific criteria

post
Authorizations
BearerstringRequired
Body
ClosedSincestring · date-time · nullableOptional
ClosedBeforestring · date-time · nullableOptional
CreatedSincestring · date-time · nullableOptional
CreatedBeforestring · date-time · nullableOptional
ModifiedSincestring · date-time · nullableOptional
ModifiedBeforestring · date-time · nullableOptional
IsPublishedboolean · nullableOptional
Responses
200

OK

Countinteger · int32Optional
Summarystring · nullableOptional
post/api/courses/count
POST /v2/e01/api/courses/count HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 275

{
  "ClosedSince": "2026-01-01T00:00:00.000Z",
  "ClosedBefore": "2026-01-01T00:00:00.000Z",
  "CreatedSince": "2026-01-01T00:00:00.000Z",
  "CreatedBefore": "2026-01-01T00:00:00.000Z",
  "ModifiedSince": "2026-01-01T00:00:00.000Z",
  "ModifiedBefore": "2026-01-01T00:00:00.000Z",
  "IsPublished": true
}
200

OK

{
  "Count": 1,
  "Summary": "text"
}

Downloads the list of courses that match specific criteria

post
Authorizations
BearerstringRequired
Body
ClosedSincestring · date-time · nullableOptional
ClosedBeforestring · date-time · nullableOptional
CreatedSincestring · date-time · nullableOptional
CreatedBeforestring · date-time · nullableOptional
ModifiedSincestring · date-time · nullableOptional
ModifiedBeforestring · date-time · nullableOptional
IsPublishedboolean · nullableOptional
Responses
200

OK

No content
post/api/courses/download
POST /v2/e01/api/courses/download HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 275

{
  "ClosedSince": "2026-01-01T00:00:00.000Z",
  "ClosedBefore": "2026-01-01T00:00:00.000Z",
  "CreatedSince": "2026-01-01T00:00:00.000Z",
  "CreatedBefore": "2026-01-01T00:00:00.000Z",
  "ModifiedSince": "2026-01-01T00:00:00.000Z",
  "ModifiedBefore": "2026-01-01T00:00:00.000Z",
  "IsPublished": true
}
200

OK

No content

Searches for the list of courses that match specific criteria

post
Authorizations
BearerstringRequired
Body
ClosedSincestring · date-time · nullableOptional
ClosedBeforestring · date-time · nullableOptional
CreatedSincestring · date-time · nullableOptional
CreatedBeforestring · date-time · nullableOptional
ModifiedSincestring · date-time · nullableOptional
ModifiedBeforestring · date-time · nullableOptional
IsPublishedboolean · nullableOptional
Responses
200

OK

CourseIdstring · uuidOptional
CourseNamestring · nullableOptional
CourseCodestring · nullableOptional
CourseLabelstring · nullableOptional
CourseHookstring · nullableOptional
CourseIsHiddenbooleanOptional
CatalogIdstring · uuid · nullableOptional
CatalogNamestring · nullableOptional
CatalogIsHiddenboolean · nullableOptional
PublicationStatusstring · nullableOptional
PublicationDatestring · date-time · nullableOptional
PublicationAuthorstring · nullableOptional
PublicationPageIdstring · uuid · nullableOptional
UnitCountinteger · int32 · nullableOptional
ModuleCountinteger · int32 · nullableOptional
ActivityCountinteger · int32 · nullableOptional
EnrollmentCountinteger · int32Optional
EnrollmentCountStartedinteger · int32Optional
EnrollmentCountCompletedinteger · int32Optional
GradebookIdstring · uuid · nullableOptional
GradebookTitlestring · nullableOptional
post/api/courses/search
POST /v2/e01/api/courses/search HTTP/1.1
Bearer: YOUR_API_KEY
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 275

{
  "ClosedSince": "2026-01-01T00:00:00.000Z",
  "ClosedBefore": "2026-01-01T00:00:00.000Z",
  "CreatedSince": "2026-01-01T00:00:00.000Z",
  "CreatedBefore": "2026-01-01T00:00:00.000Z",
  "ModifiedSince": "2026-01-01T00:00:00.000Z",
  "ModifiedBefore": "2026-01-01T00:00:00.000Z",
  "IsPublished": true
}
200

OK

[
  {
    "CourseId": "123e4567-e89b-12d3-a456-426614174000",
    "CourseName": "text",
    "CourseCode": "text",
    "CourseLabel": "text",
    "CourseHook": "text",
    "CourseIsHidden": true,
    "CatalogId": "123e4567-e89b-12d3-a456-426614174000",
    "CatalogName": "text",
    "CatalogIsHidden": true,
    "PublicationStatus": "text",
    "PublicationDate": "2026-01-01T00:00:00.000Z",
    "PublicationAuthor": "text",
    "PublicationPageId": "123e4567-e89b-12d3-a456-426614174000",
    "UnitCount": 1,
    "ModuleCount": 1,
    "ActivityCount": 1,
    "EnrollmentCount": 1,
    "EnrollmentCountStarted": 1,
    "EnrollmentCountCompleted": 1,
    "GradebookId": "123e4567-e89b-12d3-a456-426614174000",
    "GradebookTitle": "text"
  }
]
PreviousContacts API: People
NextDiagnostics API

Last updated

Was this helpful?