Skip to main content
GET
Export student enrollments as CSV

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Query Parameters

page
integer
default:1

The collection page number

itemsPerPage
integer
default:30

The number of items per page

Required range: 0 <= x <= 100
pagination
boolean

Enable or disable pagination

course
string
course[]
string[]
course.uuid
string
course.uuid[]
string[]
user
string
user[]
string[]
status
string
status[]
string[]
enrolledAt[before]
string
enrolledAt[strictly_before]
string
enrolledAt[after]
string
enrolledAt[strictly_after]
string
completedAt[before]
string
completedAt[strictly_before]
string
completedAt[after]
string
completedAt[strictly_after]
string
order[enrolledAt]
enum<string>
default:asc
Available options:
asc,
desc
order[progress]
enum<string>
default:asc
Available options:
asc,
desc
order[status]
enum<string>
default:asc
Available options:
asc,
desc
order[completedAt]
enum<string>
default:asc
Available options:
asc,
desc
order[dateUpdated]
enum<string>
default:asc
Available options:
asc,
desc

Response

CourseEnrollment collection

id
integer
read-only
uuid
string | null
user
object
enrolledAt
string<date-time>
lastAccessedAt
string<date-time> | null
progress
number
default:0
status
string
default:enrolled
progressData
(string | null)[] | null
dateUpdated
string<date-time>