Courses API: Courses

Retrieves one specific course

get

Authorizations

BearerCookie

BearerstringRequired

Path parameters

coursestring · uuidRequired

Responses

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

get

/api/courses/{course}

HTTPcURLJavaScriptPython

GET /v2/e01/api/courses/{course} HTTP/1.1
Bearer: YOUR_API_KEY
Accept: */*

404

Not Found

{
  "Type": "text",
  "Title": "text",
  "Status": 1,
  "Detail": "text",
  "Instance": "text",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Checks for the existence of one specific course

head

Authorizations

BearerCookie

BearerstringRequired

Path parameters

coursestring · uuidRequired

Responses

200

OK

404

Not Found

application/jsontext/json

Typestring · nullableOptional

Titlestring · nullableOptional

Statusinteger · int32 · nullableOptional

Detailstring · nullableOptional

Instancestring · nullableOptional

Other propertiesanyOptional

head

/api/courses/{course}

HTTPcURLJavaScriptPython

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

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

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

application/jsontext/json

post

/api/courses/collect

HTTPcURLJavaScriptPython

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-05-08T23:54:01.294Z",
  "ClosedBefore": "2026-05-08T23:54:01.294Z",
  "CreatedSince": "2026-05-08T23:54:01.294Z",
  "CreatedBefore": "2026-05-08T23:54:01.294Z",
  "ModifiedSince": "2026-05-08T23:54:01.294Z",
  "ModifiedBefore": "2026-05-08T23:54:01.294Z",
  "IsPublished": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

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-05-08T23:54:01.294Z",
    "Created": "2026-05-08T23:54:01.294Z",
    "Modified": "2026-05-08T23:54:01.294Z"
  }
]

Counts the courses that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

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

application/jsontext/json

post

/api/courses/count

HTTPcURLJavaScriptPython

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-05-08T23:54:01.294Z",
  "ClosedBefore": "2026-05-08T23:54:01.294Z",
  "CreatedSince": "2026-05-08T23:54:01.294Z",
  "CreatedBefore": "2026-05-08T23:54:01.294Z",
  "ModifiedSince": "2026-05-08T23:54:01.294Z",
  "ModifiedBefore": "2026-05-08T23:54:01.294Z",
  "IsPublished": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

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

Downloads the list of courses that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

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

post

/api/courses/download

HTTPcURLJavaScriptPython

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-05-08T23:54:01.294Z",
  "ClosedBefore": "2026-05-08T23:54:01.294Z",
  "CreatedSince": "2026-05-08T23:54:01.294Z",
  "CreatedBefore": "2026-05-08T23:54:01.294Z",
  "ModifiedSince": "2026-05-08T23:54:01.294Z",
  "ModifiedBefore": "2026-05-08T23:54:01.294Z",
  "IsPublished": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

Searches for the list of courses that match specific criteria

post

Authorizations

BearerCookie

BearerstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

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

application/jsontext/json

post

/api/courses/search

HTTPcURLJavaScriptPython

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-05-08T23:54:01.294Z",
  "ClosedBefore": "2026-05-08T23:54:01.294Z",
  "CreatedSince": "2026-05-08T23:54:01.294Z",
  "CreatedBefore": "2026-05-08T23:54:01.294Z",
  "ModifiedSince": "2026-05-08T23:54:01.294Z",
  "ModifiedBefore": "2026-05-08T23:54:01.294Z",
  "IsPublished": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

[
  {
    "CourseId": "123e4567-e89b-12d3-a456-426614174000",
    "CourseName": "text",
    "CourseCode": "text",
    "CourseLabel": "text",
    "CourseHook": "text",
    "CatalogId": "123e4567-e89b-12d3-a456-426614174000",
    "CatalogName": "text",
    "PublicationStatus": "text",
    "PublicationDate": "2026-05-08T23:54:01.294Z",
    "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"
  }
]