Courses
General search query (title OR description OR tags)
Search by title
Search by tag name
Filter by whether currently open for enrollment
Filter by account id (must be the current account or one of its subcatalogs)
When used with account_id, also include listings from that account's descendant subcatalogs
courses listed
GET /api/v1/courses HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
courses listed
{
"courses": [
{
"id": 1,
"visibility": "text",
"enrollment_open": true,
"enrollment_open_from": "text",
"enrollment_open_to": "text",
"enrollment_cap": 1,
"hide_enrollment_info": true,
"description": "text",
"enrollment_fee": 1,
"created_at": "text",
"credits": 1,
"measurement": "text",
"updated_at": "text",
"short_description": "text",
"listing_path": "text",
"listing_image": "text",
"currency": "text",
"catalog": {
"id": 1,
"name": "text"
},
"type": "text",
"title": "text",
"subtitle": "text",
"list_order": 1,
"waitlist": true,
"waitlist_cap": 1,
"sku": "text",
"sitemap_priority": "text",
"show_free_banner": true,
"image_alt_text": "text",
"allowed_payment_types": [
"text"
],
"tag_names": [
"text"
],
"listing_url": "text",
"start_date": "text",
"end_date": "text",
"canvas_section_id": 1,
"associated_account_ids": [
1
],
"archived_at": "text",
"canvas_course": {
"id": 1
},
"instructor_names": [
"text"
],
"primary_instructor_name": "text"
}
]
}A sub-account API key must leave tag_names out of the body (it gets 403 otherwise, even for an empty array or null). account_id must be in the key's subtree, and the key cannot add or remove associated_account_ids entries outside its subtree (422 otherwise).
course created
a subaccount-scoped key must omit tag_names; an empty array or null is also rejected
a subaccount-scoped key may not set associated_account_ids outside its subtree
POST /api/v1/courses HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 422
{
"course": {
"title": "text",
"description": "text",
"path": "text",
"teaser": "text",
"enrollment_open": true,
"visibility": "text",
"enrollment_cap": 1,
"enrollment_fee": 1,
"days_to_complete": 1,
"waitlist": true,
"waitlist_cap": 1,
"list_order": 1,
"sku": "text",
"sitemap_priority": "text",
"canvas_course_id": 1,
"canvas_section_id": 1,
"credits": 1,
"subtitle": "text",
"instructor_names": [
"text"
],
"primary_instructor_name": "text",
"tag_names": [
"text"
]
}
}{
"course": {
"id": 1,
"visibility": "text",
"enrollment_open": true,
"enrollment_open_from": "text",
"enrollment_open_to": "text",
"enrollment_cap": 1,
"hide_enrollment_info": true,
"description": "text",
"enrollment_fee": 1,
"created_at": "text",
"credits": 1,
"measurement": "text",
"updated_at": "text",
"short_description": "text",
"listing_path": "text",
"listing_image": "text",
"currency": "text",
"catalog": {
"id": 1,
"name": "text"
},
"type": "text",
"title": "text",
"subtitle": "text",
"list_order": 1,
"waitlist": true,
"waitlist_cap": 1,
"sku": "text",
"sitemap_priority": "text",
"show_free_banner": true,
"image_alt_text": "text",
"allowed_payment_types": [
"text"
],
"tag_names": [
"text"
],
"listing_url": "text",
"start_date": "text",
"end_date": "text",
"canvas_section_id": 1,
"associated_account_ids": [
1
],
"archived_at": "text",
"canvas_course": {
"id": 1
},
"instructor_names": [
"text"
],
"primary_instructor_name": "text"
}
}Identifier for this course
course found
GET /api/v1/courses/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
course found
{
"course": {
"id": 1,
"visibility": "text",
"enrollment_open": true,
"enrollment_open_from": "text",
"enrollment_open_to": "text",
"enrollment_cap": 1,
"hide_enrollment_info": true,
"description": "text",
"enrollment_fee": 1,
"created_at": "text",
"credits": 1,
"measurement": "text",
"updated_at": "text",
"short_description": "text",
"listing_path": "text",
"listing_image": "text",
"currency": "text",
"catalog": {
"id": 1,
"name": "text"
},
"type": "text",
"title": "text",
"subtitle": "text",
"list_order": 1,
"waitlist": true,
"waitlist_cap": 1,
"sku": "text",
"sitemap_priority": "text",
"show_free_banner": true,
"image_alt_text": "text",
"allowed_payment_types": [
"text"
],
"tag_names": [
"text"
],
"listing_url": "text",
"start_date": "text",
"end_date": "text",
"canvas_section_id": 1,
"associated_account_ids": [
1
],
"archived_at": "text",
"canvas_course": {
"id": 1
},
"instructor_names": [
"text"
],
"primary_instructor_name": "text"
}
}GET /api/v1/courses/{id} always returns tag_names, so a sub-account API key that sends a fetched course back unchanged gets 403. Remove tag_names first. A sub-account key also gets 422 for an account_id outside its subtree or an associated_account_ids entry that cannot be read as an integer id, and 404 for a course outside its subtree. Adding or removing an associated_account_ids entry outside the subtree returns 422 (unchanged entries are fine). When a body has more than one of these problems, the response does not guarantee which error comes back.
Identifier for this course
course updated
No content
a subaccount-scoped key must omit tag_names; an empty array or null is also rejected
a subaccount-scoped key may not set associated_account_ids outside its subtree
PUT /api/v1/courses/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 422
{
"course": {
"title": "text",
"description": "text",
"path": "text",
"teaser": "text",
"enrollment_open": true,
"visibility": "text",
"enrollment_cap": 1,
"enrollment_fee": 1,
"days_to_complete": 1,
"waitlist": true,
"waitlist_cap": 1,
"list_order": 1,
"sku": "text",
"sitemap_priority": "text",
"canvas_course_id": 1,
"canvas_section_id": 1,
"credits": 1,
"subtitle": "text",
"instructor_names": [
"text"
],
"primary_instructor_name": "text",
"tag_names": [
"text"
]
}
}No content
Identifier for this course
course deleted
No content
DELETE /api/v1/courses/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
course deleted
No content
Action to perform: archive or reactivate
Product ids to act on
all courses processed
No content
some courses could not be processed
PUT /api/v1/courses/archived HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 43
{
"product_action": "text",
"product_ids": [
1
]
}No content
SKU import enqueued
No content
PUT /api/v1/courses/update_skus HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 8
"binary"SKU import enqueued
No content
Last updated
Was this helpful?