List enrollments
enrollment_listList enrollment records on this site, newest enrollment first: who is enrolled or waitlisted in which course, and how far along they are. Narrow it to one learner by email or userId (every course they are in, or with courseId their single enrollment; an unknown email returns an empty list), by course, by exact status label, or to the waitlist queue (waitlisted:true) or everyone off it (waitlisted:false); status:"pending" with waitlisted:false finds enrolled learners who still see an enrollment step instead of Start/Continue (for example, ones unlocked from the waitlist in the dashboard). Course applications awaiting a decision are not enrollments: see application_list. Each row has courseId, userId, status, isWaitListed, enrolledAt, expiresAt, user {id, name, email, username}, progressPercentage (0 if not started) and completedAt (set when the learner first completes the course). Returns {total, enrollments}; page with offset until it reaches total. To change or revoke one learner's enrollment, pass their email straight to enrollment_update or enrollment_revoke.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | Only this learner's enrollments, by account email (case-insensitive). An email with no account or no enrollment on this site returns an empty list. | ||
| limit | No | Max rows (default 100; values above 500 are capped at 500). | |
| offset | No | Rows to skip (default 0); compare with total to page. | |
| status | No | Only rows with exactly this status label, e.g. "completed" (API enrollments, approved applications and payments; the only label that gives learners the Start/Continue button), "pending" (a learner who joined a waitlist, or one the dashboard added or unlocked) or "active" (learning-path enrollments). The label is about the enrollment, not course completion (see progressPercentage and completedAt). | |
| userId | No | Only this learner's enrollments, by user id (user.id in the rows). | |
| courseId | No | Only enrollments in this course (must be on this site). Combine with email or userId to get one learner's enrollment in it. | |
| waitlisted | No | true = only waitlisted learners; false = only learners off the waitlist; omit for both. |