ExternalLmsServer

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

ExternalLmsServer

FieldTypeRequiredDescription
idstring (uuid)yes—
organization_idstring (uuid)yes—
slugstringyes—
namestringyes—
descriptionstring | nullyes—
base_urlstring | nullyes

Where the server lives, for humans; the LRS never calls it.

lms_kindstring | nullyes—
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",
  "organization_id": "1b671a64-40d5-491e-99b0-da01ff1f3341",
  "slug": "string",
  "name": "string",
  "description": "string",
  "base_url": "string",
  "lms_kind": "string",
  "created_at": "2026-01-01T00:00:00.000Z",
  "archived_at": "2026-01-01T00:00:00.000Z"
}