Get One Training Course
GET https://api.suger.cloud/ai/org/{orgId}/prm/course/{courseId}
Return one course with its modules, lessons and settings. `courseId` is the `id` of a row from ListCourses. For a course this organization wrote, `version` is `draft` (the default, the working copy), `published` (the version partners take) or a version number. For a course another organization shared with this one, `version` is ignored: the published version comes back without quiz answers, and 404 means the course is unpublished or no longer shared.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
orgId | path | string | yes | Organization ID |
courseId | path | string | yes | Course ID |
version | query | string | no | draft (default) or published |
Responses
200 — Course + resolved version
Content-Type: application/json · Schema: CourseDetail
CourseDetail fields:
| Field | Type | Required | Description |
|---|---|---|---|
course | Course | no | |
version | CourseVersion | no |
Course fields:
| Field | Type | Required | Description |
|---|---|---|---|
archivedAt | string | no | Set by the archive transition — course retired (hidden from catalog/new enrollment); pinned learners still continue per the access rule |
category | string | no | Optional listing tag, e.g. Co-Sell / Technical / Sales / Onboarding |
certificateIds | array<string> | no | Certificate IDs this course grants on pass (0..N). NOT NULL default '[]' in HCL = grants none. Read live at pass time (grant set is not version-pinned). |
createTime | string | no | Creation timestamp |
createdByUserId | string | no | Creator's user id |
createdByUserName | string | no | Creator display name |
currentPublishedVersionId | string | no | The live version. NULL = not published |
deletedAt | string | no | The time it was deleted; empty while it is active. |
description | string | no | Optional description (listing metadata — not versioned) |
draftVersionId | string | no | The working draft |
id | string | no | ID of the ent. Unique course identifier (UUID) |
kind | string | no | Content kind: native (BlockNote modules) | scorm (uploaded package). Immutable after create; drives publish gate, runtime, and the listing badge. |
lastUpdateTime | string | no | Last update timestamp |
lastUpdatedByUserId | string | no | User id of the last editor ("Updated By") |
lastUpdatedByUserName | string | no | last-editor display name |
name | string | no | Display name (listing metadata — not versioned) |
sharingMode | string | no | Private, All Partners, Specific Partners (Title-Case display values) |
sourceOrgId | string | no | Owner/author org — tenant isolation; "My Courses" = source_org_id = caller |
targetOrgId | array<string> | no | Recipient org IDs for specific_partners sharing |
CourseVersion fields:
| Field | Type | Required | Description |
|---|---|---|---|
courseId | string | no | |
createTime | string | no | Creation timestamp |
createdByUserId | string | no | User id that created this version |
id | string | no | ID of the ent. Unique course version identifier (UUID) |
info | CourseInfo | no | |
lastUpdateTime | string | no | Last update timestamp (DRAFT only; PUBLISHED/ARCHIVED are immutable) |
publishedAt | string | no | Set when the version is published |
status | string | no | Draft (mutable) | Published | Archived (both immutable). Title-Case display values. |
versionNo | integer | no | Monotonic version number per course (1, 2, 3...) |
CourseInfo fields:
| Field | Type | Required | Description |
|---|---|---|---|
continueButton | CourseContinueButton | no | |
external | ExternalCourseDestination | no | |
modules | array<CourseModule> | no | |
scorm | ScormPackage | no |
CourseContinueButton fields:
| Field | Type | Required | Description |
|---|---|---|---|
alignment | string | no | left | center | right |
label | string | no | |
type | string | no | NEXT | FINISH |
ExternalCourseDestination fields:
| Field | Type | Required | Description |
|---|---|---|---|
category | string | no | Category and DurationMin are CATALOG METADATA the seller types in, not anything Fours reads back out of the external LMS. They let an external course carry the same at-a-glance shape as a native one (a grouping label and a length) without implying observation: DurationMin is the seller's ESTIMATE of how long the course takes, never a measurement of how long any learner actually spent. Both are optional; a destination alone is a complete external course. |
durationMin | integer | no | |
externalCourseGroupId | string | no | ExternalCourseGroupID is the SAME course's domain-independent id, stored alongside the per-domain one so a completion earned on a different training domain still matches. Recorded when the seller picks from the live course list; empty for anything created before or by hand. |
externalCourseId | string | no | ExternalCourseID is the id the SOURCE LMS uses for this course, and the key a CompletionFact is matched on. The URL cannot do that job: it is a deep link a seller pastes, it changes when a course is renamed or re-slugged, and nothing in a completion payload contains it. Optional, and it must stay optional — every external course created before has none, and requiring one would make those rows unsaveable. A course without it simply never matches a completion. For Skilljar specifically this is the PUBLISHED-course id, not the admin course id: published courses are per training domain, so one course published to two domains has two ids, and enrollments and webhooks quote the published one. |
provider | string | no | display-only, e.g. "Skilljar" |
url | string | no |
CourseModule fields:
| Field | Type | Required | Description |
|---|---|---|---|
id | string | no | |
lessons | array<CourseLesson> | no | |
position | integer | no | |
title | string | no |
ScormPackage fields:
| Field | Type | Required | Description |
|---|---|---|---|
description | string | no | |
launchUrl | string | no | entry HTML, relative to S3Prefix |
s3Prefix | string | no | durable key prefix of the extracted package |
scos | array<ScormSCO> | no | ordered, from <organizations> |
title | string | no | manifest-derived (pre-fills course name) |
version | string | no | ScormVersion12 | ScormVersion2004 |
CourseLesson fields:
| Field | Type | Required | Description |
|---|---|---|---|
content | array<integer> | no | |
continueButtonOverride | CourseContinueButton | no | |
estimatedMinutes | integer | no | |
id | string | no | |
isRequired | boolean | no | |
position | integer | no | |
title | string | no |
ScormSCO fields:
| Field | Type | Required | Description |
|---|---|---|---|
href | string | no | launch path relative to S3Prefix |
id | string | no | |
order | integer | no | document order within the manifest |
required | boolean | no | counts toward course completion (default true) |
title | string | no |
404 — Course not found / not visible
Content-Type: application/json
500 — Internal server error
Content-Type: application/json
Example
Generated from this operation's schema. Values are placeholders —
substitute your own ids, and set SUGER_TOKEN to a bearer token
from the OAuth client-credentials exchange.
Request
curl -X GET 'https://api.suger.cloud/ai/org/{orgId}/prm/course/{courseId}' \
-H "Authorization: Bearer $SUGER_TOKEN" Response — 200
{
"course": {
"archivedAt": "string",
"category": "string",
"certificateIds": [
"01H0000000000000000000"
],
"createTime": "2026-01-31T12:00:00Z",
"createdByUserId": "01H0000000000000000000",
"createdByUserName": "Acme Corp",
"currentPublishedVersionId": "01H0000000000000000000",
"deletedAt": "string",
"description": "string",
"draftVersionId": "01H0000000000000000000",
"id": "01H0000000000000000000",
"kind": "string"
},
"version": {
"courseId": "01H0000000000000000000",
"createTime": "2026-01-31T12:00:00Z",
"createdByUserId": "01H0000000000000000000",
"id": "01H0000000000000000000",
"info": {
"continueButton": {
"alignment": "string",
"label": "string",
"type": "string"
},
"external": {
"category": "string",
"durationMin": 1,
"externalCourseGroupId": "01H0000000000000000000",
"externalCourseId": "01H0000000000000000000",
"provider": "string",
"url": "https://example.com"
},
"modules": [
{
"id": "01H0000000000000000000",
"lessons": [],
"position": 1,
"title": "string"
}
],
"scorm": {
"description": "string",
"launchUrl": "https://example.com",
"s3Prefix": "string",
"scos": [
{}
],
"title": "string",
"version": "string"
}
},
"lastUpdateTime": "2026-01-31T12:00:00Z",
"publishedAt": "string",
"status": "string",
"versionNo": 1
}
} Error — 404
"string" View as Markdown · API reference overview
Spotted something wrong or out of date on this page? Tell us and we'll correct it.