Courses
Last updated
Was this helpful?
Last updated
Was this helpful?
DELETE /api/v1/courses/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
Deleting a specific course
{}GET /api/v1/courses HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
Listing courses
{
"courses": [
{
"id": 37,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_36",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:24 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:24 +0000",
"short_description": "teaser_36",
"listing_path": "course-path-36",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 53,
"name": "Domain Account 62"
},
"type": "Course",
"title": "Course 36",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_22",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [
"Another Tag",
"Tag"
],
"listing_url": "http://www.my-catalog.edu/courses/course-path-36",
"start_date": "2025/03/21 13:11:24 +0000",
"end_date": "2025/04/04 13:11:24 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 22
}
}
]
}GET /api/v1/courses/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
Getting a specific course
{
"course": {
"id": 35,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_34",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:24 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:24 +0000",
"short_description": "teaser_34",
"listing_path": "course-path-34",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 50,
"name": "Domain Account 58"
},
"type": "Course",
"title": "Course 34",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_20",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [
"Another Tag",
"Tag"
],
"listing_url": "http://www.my-catalog.edu/courses/course-path-34",
"start_date": "2025/03/21 13:11:24 +0000",
"end_date": "2025/04/04 13:11:24 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 20
}
}
}Listing SKU for a course
PUT /api/v1/courses/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 524
{
"course": {
"title": "text",
"description": "text",
"path": "text",
"teaser": "text",
"enrollment_open": "text",
"enrollment_open_from": "text",
"enrollment_open_to": "text",
"visibility": "text",
"enrollment_cap": "text",
"enrollment_fee": "text",
"allowed_payment_types": "text",
"days_to_complete": "text",
"account_id": "text",
"list_order": "text",
"waitlist": "text",
"waitlist_cap": "text",
"listing_image": "text",
"tag_names": [
"text"
],
"show_free_banner": "text",
"associated_account_ids": "text",
"canvas_course_id": "text",
"credits": "text"
},
"sku": "text"
}Updating a course
{}CSV containing a Catalog Course ID and Catalog Course SKU header
PUT /api/v1/courses/update_skus HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 23
{
"attachment": "binary"
}Updating course sku
{
"progress": {
"id": 2,
"account_id": 51,
"canvas_user_id": null,
"completion_percent": null,
"workflow_state": "queued",
"payload": {},
"created_at": "2025/03/28 13:11:24 +0000",
"updated_at": "2025/03/28 13:11:24 +0000"
}
}Listing SKU for a course
POST /api/v1/courses HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 524
{
"course": {
"title": "text",
"description": "text",
"path": "text",
"teaser": "text",
"enrollment_open": "text",
"enrollment_open_from": "text",
"enrollment_open_to": "text",
"visibility": "text",
"enrollment_cap": "text",
"enrollment_fee": "text",
"allowed_payment_types": "text",
"days_to_complete": "text",
"account_id": "text",
"list_order": "text",
"waitlist": "text",
"waitlist_cap": "text",
"listing_image": "text",
"tag_names": [
"text"
],
"show_free_banner": "text",
"associated_account_ids": "text",
"canvas_course_id": "text",
"credits": "text"
},
"sku": "text"
}Creating a course
{
"course": {
"id": 38,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": 150,
"description": "This is a very important course.",
"enrollment_fee": 49.99,
"created_at": "2025/03/28 13:11:25 +0000",
"credits": 4,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:25 +0000",
"short_description": "This is an example teaser",
"listing_path": "course-1",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 54,
"name": "Domain Account 63"
},
"type": "Course",
"title": "Course 1",
"list_order": 123,
"waitlist": true,
"waitlist_cap": 25,
"sku": "abc1234",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [
"Tag",
"Another Tag"
],
"listing_url": "http://www.my-catalog.edu/courses/course-1",
"start_date": null,
"end_date": null,
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 10010010
}
}
}