Enrollments
get
Authorizations
Query parameters
listing_idstringOptional
Only include enrollments for the specified listing
Responses
200
Listing enrollments
application/json
Responseobject
get
GET /api/v1/enrollments HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200
Listing enrollments
{
"enrollments": [
{
"id": 5,
"user": {
"id": 1
},
"listing": {
"id": 30,
"title": "Course 28",
"type": "Course",
"canvas_course_id": 18
},
"enrolled_at": "2025/06/24 07:20:55 +0000",
"status": "active",
"requirement_details": {
"requirement_count": null,
"requirement_completed_count": null,
"requirement_completed_percentage": null
}
}
]
}
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
201
Creating an enrollment
application/json
post
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": 2,
"user": {
"id": 1
},
"listing": {
"id": 27,
"title": "Course 25",
"type": "Course",
"canvas_course_id": 15
},
"enrolled_at": "2025/06/24 07:20:55 +0000",
"status": "active",
"requirement_details": {
"requirement_count": 10,
"requirement_completed_count": 4,
"requirement_completed_percentage": 40
}
}
}
get
Authorizations
Path parameters
idintegerRequired
Responses
200
Getting a specific enrollment
application/json
get
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": 29,
"title": "Course 27",
"type": "Course",
"canvas_course_id": 17
},
"enrolled_at": "2025/06/24 07:20:55 +0000",
"status": "active",
"requirement_details": {
"requirement_count": 10,
"requirement_completed_count": 4,
"requirement_completed_percentage": 40
}
}
}
delete
Authorizations
Path parameters
idintegerRequired
Responses
204
Deleting an enrollment
*/*
delete
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",
"requirement_details": {
"requirement_count": "text",
"requirement_completed_count": "text",
"requirement_completed_percentage": "text"
}
}
Last updated
Was this helpful?