ExternalLmsCourse

A request or response body; the type column links to the schemas it refers to.

ExternalLmsCourse

FieldTypeRequiredDescription
idstring (uuid)yes—
server_idstring (uuid)yes—
organization_idstring (uuid)yes—
external_course_idstringyes

The LMS's own identifier — the key grades arrive under; unique per server.

namestringyes—
descriptionstring | nullyes—
course_urlstring | nullyes—
passing_scorenumber | nullyes

Score required to pass, 0-100. Authoritative when set; when null, the imported passed flag decides.

subjectsarray of ExternalCourseSubjectyes

The subject matters imported grade records are filed under, alphabetically; empty for an untagged course.

created_atstring (date-time)yes—
archived_atstring (date-time) | nullyes

When set, the record is retired; it stays readable but should not grow.

jsonExample
{
  "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "server_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "external_course_id": "string",
  "name": "string",
  "description": "string",
  "course_url": "string",
  "passing_score": 0,
  "subjects": [
    {
      "id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
      "slug": "string",
      "name": "string"
    }
  ],
  "created_at": "2026-01-01T00:00:00.000Z",
  "archived_at": "2026-01-01T00:00:00.000Z"
}