Enrollments

get

Authorizations

Query parameters

listing_idstringOptional

Only include enrollments for the specified listing

Responses

Responseobject

get

HTTPcURLJavaScriptPython

GET /api/v1/enrollments HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*

200

Listing enrollments

{
  "enrollments": [
    {
      "id": 1,
      "user": {
        "id": 1
      },
      "listing": {
        "id": 4,
        "title": "Course 4",
        "type": "Course",
        "canvas_course_id": 4
      },
      "enrolled_at": "2025/03/28 13:11:22 +0000",
      "status": "active"
    }
  ]
}

post

Authorizations

Body

create_orderstringOptional

Create an order record for this enrollment, defaults to true

send_emailstringOptional

Send an enrollment email to the user, defaults to true

Responses

post

HTTPcURLJavaScriptPython

POST /api/v1/enrollments HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 102

{
  "create_order": "text",
  "send_email": "text",
  "enrollment": {
    "listing_id": "text",
    "canvas_user_id": "text"
  }
}

201

Creating an enrollment

{
  "enrollment": {
    "id": 3,
    "user": {
      "id": 1
    },
    "listing": {
      "id": 6,
      "title": "Course 6",
      "type": "Course",
      "canvas_course_id": 6
    },
    "enrolled_at": "2025/03/28 13:11:22 +0000",
    "status": "active"
  }
}

get

Authorizations

Path parameters

idintegerRequired

Responses

get

HTTPcURLJavaScriptPython

GET /api/v1/enrollments/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*

200

Getting a specific enrollment

{
  "enrollment": {
    "id": 4,
    "user": {
      "id": 1
    },
    "listing": {
      "id": 7,
      "title": "Course 7",
      "type": "Course",
      "canvas_course_id": 7
    },
    "enrolled_at": "2025/03/28 13:11:23 +0000",
    "status": "active"
  }
}

delete

Authorizations

Path parameters

idintegerRequired

Responses

delete

HTTPcURLJavaScriptPython

DELETE /api/v1/enrollments/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*

204

Deleting an enrollment

{
  "id": "text",
  "user": {
    "id": "text"
  },
  "listing": {
    "id": "text",
    "title": "text",
    "type": "text",
    "canvas_course_id": "text"
  },
  "enrolled_at": "text",
  "status": "text"
}