Courses

List and read courses and their outlines; create drafts and update details.

Scopescourses:readcourses:write

Data requests act inside the key’s centre as the person who created the key: each needs the scope and that person’s current EduMark permission. See auth and pagination.

List courses

GET/v1/courses

Courses the key's creator can see, newest first. A page can hold fewer than limit courses when some are hidden from them; keep following next_cursor while has_more.

Scope courses:read

Parameters

List courses: parameters
Field	Details
`limit`	integerItems per page, 1 to 100.1 to 100Default `25`
`cursor`	string, optionalThe `next_cursor` from the previous page.Up to 512 characters
`updated_since`	string, optional
`status`	enum, optionalOne of `draft`, `published`, `archived`

Headers

List courses: headers
Field	Details
`EduMark-Version`	enumAPI version. Defaults to the latest.One of `2026-10-21`

Responses

Status	Meaning
200	Successful Response
400	Request rejected. Inspect error.code and request_id; failed work is not billed.
401	Request rejected. Inspect error.code and request_id; failed work is not billed.
403	Request rejected. Inspect error.code and request_id; failed work is not billed.
404	Request rejected. Inspect error.code and request_id; failed work is not billed.
409	Request rejected. Inspect error.code and request_id; failed work is not billed.
410	Request rejected. Inspect error.code and request_id; failed work is not billed.
413	Request rejected. Inspect error.code and request_id; failed work is not billed.
415	Request rejected. Inspect error.code and request_id; failed work is not billed.
422	Validation Error
429	Request rejected. Inspect error.code and request_id; failed work is not billed.
503	Request rejected. Inspect error.code and request_id; failed work is not billed.

Create a draft course

POST/v1/courses

Creates an empty draft course in your team. Build and publish it in Course Studio.

Scope courses:write

Headers

Create a draft course: headers
Field	Details
`Idempotency-Key`	stringRequiredA unique key per new course.
`EduMark-Version`	enumAPI version. Defaults to the latest.One of `2026-10-21`

Request body

Create a draft course: request body
Field	Details
`code`	stringRequiredYour course code. Unique in your team.Up to 80 charactersPattern `^[A-Za-z0-9][A-Za-z0-9._ /-]{0,79}$`
`title`	stringRequiredUp to 300 characters
`description`	stringUp to 20,000 charactersDefault `""`

Responses

Status	Meaning
201	Successful Response
400	Request rejected. Inspect error.code and request_id; failed work is not billed.
401	Request rejected. Inspect error.code and request_id; failed work is not billed.
403	Request rejected. Inspect error.code and request_id; failed work is not billed.
404	Request rejected. Inspect error.code and request_id; failed work is not billed.
409	Request rejected. Inspect error.code and request_id; failed work is not billed.
410	Request rejected. Inspect error.code and request_id; failed work is not billed.
413	Request rejected. Inspect error.code and request_id; failed work is not billed.
415	Request rejected. Inspect error.code and request_id; failed work is not billed.
422	Validation Error
429	Request rejected. Inspect error.code and request_id; failed work is not billed.
503	Request rejected. Inspect error.code and request_id; failed work is not billed.

Request

curl -X POST 'https://api.edumark.ai/v1/courses' \
  -H "Authorization: Bearer $EDUMARK_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "code": "BIO-GCSE-1",
  "description": "Cells, respiration and photosynthesis in eight short lessons.",
  "title": "GCSE Biology: Cells and energy"
}'

Response 201JSON

{
  "code": "BIO-GCSE-1",
  "created_at": "2026-09-01T09:00:00Z",
  "description": "Cells, respiration and photosynthesis in eight short lessons.",
  "id": "course_1a2b3c4d5e6f",
  "is_template": false,
  "shared_across_organisation": false,
  "status": "published",
  "title": "GCSE Biology: Cells and energy",
  "updated_at": "2026-10-02T14:12:00Z"
}

Get a course

GET/v1/courses/{course_id}

Scope courses:read

Parameters

Get a course: parameters
Field	Details
`course_id`	stringRequired

Headers

Get a course: headers
Field	Details
`EduMark-Version`	enumAPI version. Defaults to the latest.One of `2026-10-21`

Responses

Status	Meaning
200	Successful Response
400	Request rejected. Inspect error.code and request_id; failed work is not billed.
401	Request rejected. Inspect error.code and request_id; failed work is not billed.
403	Request rejected. Inspect error.code and request_id; failed work is not billed.
404	Request rejected. Inspect error.code and request_id; failed work is not billed.
409	Request rejected. Inspect error.code and request_id; failed work is not billed.
410	Request rejected. Inspect error.code and request_id; failed work is not billed.
413	Request rejected. Inspect error.code and request_id; failed work is not billed.
415	Request rejected. Inspect error.code and request_id; failed work is not billed.
422	Validation Error
429	Request rejected. Inspect error.code and request_id; failed work is not billed.
503	Request rejected. Inspect error.code and request_id; failed work is not billed.

Request

curl 'https://api.edumark.ai/v1/courses/course_123' \
  -H "Authorization: Bearer $EDUMARK_API_KEY"

Response 200JSON

{
  "code": "BIO-GCSE-1",
  "created_at": "2026-09-01T09:00:00Z",
  "description": "Cells, respiration and photosynthesis in eight short lessons.",
  "id": "course_1a2b3c4d5e6f",
  "is_template": false,
  "shared_across_organisation": false,
  "status": "published",
  "title": "GCSE Biology: Cells and energy",
  "updated_at": "2026-10-02T14:12:00Z"
}

Update a course's details

PATCH/v1/courses/{course_id}

Changes the code, title or description. Learners on a published course are told about important changes, as they are when you edit in EduMark.

Scope courses:write

Parameters

Update a course's details: parameters
Field	Details
`course_id`	stringRequired

Headers

Update a course's details: headers
Field	Details
`EduMark-Version`	enumAPI version. Defaults to the latest.One of `2026-10-21`

Request body

Update a course's details: request body
Field	Details
`code`	string, optionalUp to 80 charactersPattern `^[A-Za-z0-9][A-Za-z0-9._ /-]{0,79}$`
`title`	string, optionalUp to 300 characters
`description`	string, optionalUp to 20,000 characters

Responses

Status	Meaning
200	Successful Response
400	Request rejected. Inspect error.code and request_id; failed work is not billed.
401	Request rejected. Inspect error.code and request_id; failed work is not billed.
403	Request rejected. Inspect error.code and request_id; failed work is not billed.
404	Request rejected. Inspect error.code and request_id; failed work is not billed.
409	Request rejected. Inspect error.code and request_id; failed work is not billed.
410	Request rejected. Inspect error.code and request_id; failed work is not billed.
413	Request rejected. Inspect error.code and request_id; failed work is not billed.
415	Request rejected. Inspect error.code and request_id; failed work is not billed.
422	Validation Error
429	Request rejected. Inspect error.code and request_id; failed work is not billed.
503	Request rejected. Inspect error.code and request_id; failed work is not billed.

Request

curl -X PATCH 'https://api.edumark.ai/v1/courses/course_123' \
  -H "Authorization: Bearer $EDUMARK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "GCSE Biology: Cells, energy and plants"
}'

Response 200JSON

{
  "code": "BIO-GCSE-1",
  "created_at": "2026-09-01T09:00:00Z",
  "description": "Cells, respiration and photosynthesis in eight short lessons.",
  "id": "course_1a2b3c4d5e6f",
  "is_template": false,
  "shared_across_organisation": false,
  "status": "published",
  "title": "GCSE Biology: Cells and energy",
  "updated_at": "2026-10-02T14:12:00Z"
}

Get a course outline

GET/v1/courses/{course_id}/structure

The modules and lessons of the course's published version (or its draft with version=draft). Lesson content is not included.

Scope courses:read

Parameters

Get a course outline: parameters
Field	Details
`course_id`	stringRequired
`version`	enumOne of `published`, `draft`Default `"published"`

Headers

Get a course outline: headers
Field	Details
`EduMark-Version`	enumAPI version. Defaults to the latest.One of `2026-10-21`

Responses

Status	Meaning
200	Successful Response
400	Request rejected. Inspect error.code and request_id; failed work is not billed.
401	Request rejected. Inspect error.code and request_id; failed work is not billed.
403	Request rejected. Inspect error.code and request_id; failed work is not billed.
404	Request rejected. Inspect error.code and request_id; failed work is not billed.
409	Request rejected. Inspect error.code and request_id; failed work is not billed.
410	Request rejected. Inspect error.code and request_id; failed work is not billed.
413	Request rejected. Inspect error.code and request_id; failed work is not billed.
415	Request rejected. Inspect error.code and request_id; failed work is not billed.
422	Validation Error
429	Request rejected. Inspect error.code and request_id; failed work is not billed.
503	Request rejected. Inspect error.code and request_id; failed work is not billed.

Request

curl 'https://api.edumark.ai/v1/courses/course_123/structure' \
  -H "Authorization: Bearer $EDUMARK_API_KEY"

Response 200JSON

{
  "course_id": "course_1a2b3c4d5e6f",
  "introduction": [],
  "modules": [
    {
      "description": "",
      "id": "node_cells",
      "kind": "module",
      "lessons": [
        {
          "id": "content_cell_structure",
          "order": 0,
          "title": "Cell structure",
          "type": "page"
        }
      ],
      "order": 0,
      "title": "Cells"
    }
  ],
  "version_id": "version_7f8e9d",
  "version_label": "Version 2",
  "version_status": "published"
}

Archive a course

POST/v1/courses/{course_id}/archive

Takes the course out of use and keeps everything in it. Restore it in EduMark.

Scope courses:write

Parameters

Archive a course: parameters
Field	Details
`course_id`	stringRequired

Headers

Archive a course: headers
Field	Details
`EduMark-Version`	enumAPI version. Defaults to the latest.One of `2026-10-21`

Responses

Status	Meaning
200	Successful Response
400	Request rejected. Inspect error.code and request_id; failed work is not billed.
401	Request rejected. Inspect error.code and request_id; failed work is not billed.
403	Request rejected. Inspect error.code and request_id; failed work is not billed.
404	Request rejected. Inspect error.code and request_id; failed work is not billed.
409	Request rejected. Inspect error.code and request_id; failed work is not billed.
410	Request rejected. Inspect error.code and request_id; failed work is not billed.
413	Request rejected. Inspect error.code and request_id; failed work is not billed.
415	Request rejected. Inspect error.code and request_id; failed work is not billed.
422	Validation Error
429	Request rejected. Inspect error.code and request_id; failed work is not billed.
503	Request rejected. Inspect error.code and request_id; failed work is not billed.

Request

curl -X POST 'https://api.edumark.ai/v1/courses/course_123/archive' \
  -H "Authorization: Bearer $EDUMARK_API_KEY"

Response 200JSON

{
  "code": "BIO-GCSE-1",
  "created_at": "2026-09-01T09:00:00Z",
  "description": "Cells, respiration and photosynthesis in eight short lessons.",
  "id": "course_1a2b3c4d5e6f",
  "is_template": false,
  "shared_across_organisation": false,
  "status": "published",
  "title": "GCSE Biology: Cells and energy",
  "updated_at": "2026-10-02T14:12:00Z"
}