Gradebook
A course run's learners, progress and released marks, using the course's gradebook rules.
- Scope
gradebook:read
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.
Get a course run's gradebook
GET/v1/gradebook/runs/{run_id}
Every learner on a course run with each item's state and their released marks, using the course's gradebook rules. Learners are paged (limit, cursor); filter to one with learner_id. Marks appear only once released. For a file, use POST /v1/reports/gradebook.
Scope gradebook:read
Parameters
| Field | Details |
|---|---|
run_id | stringRequiredUp to 200 charactersPattern ^[A-Za-z0-9][A-Za-z0-9._:-]{0,199}$ |
learner_id | string, optionalUp to 200 charactersPattern ^[A-Za-z0-9][A-Za-z0-9._:-]{0,199}$ |
limit | integerItems per page, 1 to 100.1 to 100Default 50 |
cursor | string, optionalThe next_cursor from the previous page.Up to 512 characters |
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. |