Enrollment API

List Enrollments

Retrieves all enrollments for the authenticated user.

Response

array

Array of enrollment objects

Show Enrollment Object

number

Unique enrollment identifier

string

User UUID

number

Course ID

string

Enrollment status: “active”, “completed”, “suspended”

number

Completion progress (0-100)

string

Enrollment timestamp (ISO 8601)

string

Completion timestamp (ISO 8601, null if not completed)

object

Embedded course object with course details

Example Request

curl https://your-domain.com/api/enrollments

Example Response

{
  "enrollments": [
    {
      "id": 1,
      "user_id": "uuid-here",
      "course_id": 42,
      "status": "active",
      "progress": 65,
      "enrolled_at": "2024-01-15T10:30:00Z",
      "completed_at": null,
      "courses": {
        "id": 42,
        "title": "Introduction to Programming",
        "image": "https://example.com/image.jpg"
      }
    }
  ]
}

Create Enrollment

Enrolls a user in a course. Checks prerequisites and updates enrollment count.

Request Body

number

required

Course ID to enroll in

string

Admin only: Enroll another user by their UUID

boolean

Admin only: Skip prerequisite checks (default: false)

Response

object

Created enrollment object

Example Request

curl -X POST https://your-domain.com/api/enrollments \
  -H "Content-Type: application/json" \
  -d '{
    "courseId": 42
  }'

Example Response

{
  "enrollment": {
    "id": 1,
    "user_id": "uuid-here",
    "course_id": 42,
    "status": "active",
    "progress": 0,
    "enrolled_at": "2024-01-15T10:30:00Z"
  }
}

Update Enrollment Status

Updates the status of an enrollment (e.g., mark as completed).

Request Body

number

required

Course ID

string

required

New status: “active”, “completed”, “suspended”

Response

object

Updated enrollment object

Example Request

curl -X PATCH https://your-domain.com/api/enrollments \
  -H "Content-Type: application/json" \
  -d '{
    "courseId": 42,
    "status": "completed"
  }'

Notes

Setting status to “completed” automatically sets completed_at timestamp and progress to 100%
Triggers email notifications for course completion
Sends admin notification about the completion

Prerequisite Validation

When enrolling in a course with prerequisites, the API validates:

All prerequisite courses must be completed
Completion is verified by completed_at timestamp being set
In-progress enrollments are not sufficient

Prerequisite Error Response

{
  "error": "Prerequisites not met",
  "missingPrerequisites": [
    {
      "id": 10,
      "title": "Introduction to Programming",
      "status": "not_started"
    },
    {
      "id": 15,
      "title": "Basic JavaScript",
      "status": "in_progress"
    }
  ]
}

Enrollment Notifications

The API automatically triggers email notifications:

On Enrollment: Welcome email with course access details
On Completion: Congratulations email with certificate link (if enabled)
Admin Notification: Notifies admin when a user completes a course

Admin Enrollment

Admins can enroll other users by providing the userId parameter:

curl -X POST https://your-domain.com/api/enrollments \
  -H "Content-Type: application/json" \
  -d '{
    "courseId": 42,
    "userId": "target-user-uuid",
    "bypassPrerequisites": true
  }'

Error Codes

Status Code	Description
200	Success
400	Bad Request - Prerequisites not met or invalid parameters
401	Unauthorized - Authentication required
403	Forbidden - Admin access required
404	Not Found - Enrollment or course not found
409	Conflict - User already enrolled
500	Internal Server Error

Overview

Resources

List Enrollments

Response

Example Request

Example Response

Create Enrollment

Request Body

Response

Example Request

Example Response

Update Enrollment Status

Request Body

Response

Example Request

Notes

Prerequisite Validation

Prerequisite Error Response

Enrollment Notifications

Admin Enrollment

Error Codes

​List Enrollments

​Response

​Example Request

​Example Response

​Create Enrollment

​Request Body

​Response

​Example Request

​Example Response

​Update Enrollment Status

​Request Body

​Response

​Example Request

​Notes

​Prerequisite Validation

​Prerequisite Error Response

​Enrollment Notifications

​Admin Enrollment

​Error Codes

List Enrollments

Response

Example Request

Example Response

Create Enrollment

Request Body

Response

Example Request

Example Response

Update Enrollment Status

Request Body

Response

Example Request

Notes

Prerequisite Validation

Prerequisite Error Response

Enrollment Notifications

Admin Enrollment

Error Codes