Programs
Last updated
Was this helpful?
Last updated
Was this helpful?
GET /api/v1/programs/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
Getting a specific program
{
"program": {
"id": 22,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_21",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 9,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_21",
"listing_path": "program-path-21",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 26,
"name": "Domain Account 34"
},
"type": "Program",
"title": "Program 21",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": null,
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [
"Another Tag",
"Tag"
],
"listing_url": "http://www.my-catalog.edu/programs/program-path-21",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": null,
"canvas_section_id": null,
"associated_account_ids": [],
"sequential": true,
"requirements": [
{
"id": 23,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_22",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_22",
"listing_path": "program-path-22",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 26,
"name": "Domain Account 34"
},
"type": "Program",
"title": "Program 22",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": null,
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/programs/program-path-22",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": null,
"canvas_section_id": null,
"associated_account_ids": [],
"sequential": true,
"requirements": [
{
"id": 25,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_24",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_24",
"listing_path": "course-path-24",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 26,
"name": "Domain Account 34"
},
"type": "Course",
"title": "Course 24",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_14",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/courses/course-path-24",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": "2025/04/04 13:11:23 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 14
}
}
]
},
{
"id": 24,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_23",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 6,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_23",
"listing_path": "program-path-23",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 26,
"name": "Domain Account 34"
},
"type": "Program",
"title": "Program 23",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": null,
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/programs/program-path-23",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": null,
"canvas_section_id": null,
"associated_account_ids": [],
"sequential": true,
"requirements": [
{
"id": 26,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_25",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_25",
"listing_path": "course-path-25",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 26,
"name": "Domain Account 34"
},
"type": "Course",
"title": "Course 25",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_15",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/courses/course-path-25",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": "2025/04/04 13:11:23 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 15
}
},
{
"id": 27,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_26",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_26",
"listing_path": "course-path-26",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 26,
"name": "Domain Account 34"
},
"type": "Course",
"title": "Course 26",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_16",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/courses/course-path-26",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": "2025/04/04 13:11:23 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 16
}
}
]
}
]
}
}DELETE /api/v1/programs/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
Deleting a specific program
{}GET /api/v1/programs HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
Listing programs
{
"programs": [
{
"id": 8,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_8",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 9,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_8",
"listing_path": "program-path-8",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Program",
"title": "Program 8",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": null,
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [
"Another Tag",
"Tag"
],
"listing_url": "http://www.my-catalog.edu/programs/program-path-8",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": null,
"canvas_section_id": null,
"associated_account_ids": [],
"sequential": true,
"requirements": [
{
"id": 9,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_9",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_9",
"listing_path": "program-path-9",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Program",
"title": "Program 9",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": null,
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/programs/program-path-9",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": null,
"canvas_section_id": null,
"associated_account_ids": [],
"sequential": true,
"requirements": [
{
"id": 11,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_11",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_11",
"listing_path": "course-path-11",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Course",
"title": "Course 11",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_8",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/courses/course-path-11",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": "2025/04/04 13:11:23 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 8
}
}
]
},
{
"id": 10,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_10",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 6,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_10",
"listing_path": "program-path-10",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Program",
"title": "Program 10",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": null,
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/programs/program-path-10",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": null,
"canvas_section_id": null,
"associated_account_ids": [],
"sequential": true,
"requirements": [
{
"id": 12,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_12",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_12",
"listing_path": "course-path-12",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Course",
"title": "Course 12",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_9",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/courses/course-path-12",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": "2025/04/04 13:11:23 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 9
}
},
{
"id": 13,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_13",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_13",
"listing_path": "course-path-13",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Course",
"title": "Course 13",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_10",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/courses/course-path-13",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": "2025/04/04 13:11:23 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 10
}
}
]
}
]
},
{
"id": 9,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_9",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_9",
"listing_path": "program-path-9",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Program",
"title": "Program 9",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": null,
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/programs/program-path-9",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": null,
"canvas_section_id": null,
"associated_account_ids": [],
"sequential": true,
"requirements": [
{
"id": 11,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_11",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_11",
"listing_path": "course-path-11",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Course",
"title": "Course 11",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_8",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/courses/course-path-11",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": "2025/04/04 13:11:23 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 8
}
}
]
},
{
"id": 10,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_10",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 6,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_10",
"listing_path": "program-path-10",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Program",
"title": "Program 10",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": null,
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/programs/program-path-10",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": null,
"canvas_section_id": null,
"associated_account_ids": [],
"sequential": true,
"requirements": [
{
"id": 12,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_12",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_12",
"listing_path": "course-path-12",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Course",
"title": "Course 12",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_9",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/courses/course-path-12",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": "2025/04/04 13:11:23 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 9
}
},
{
"id": 13,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": null,
"description": "description_13",
"enrollment_fee": 0,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": 3,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "teaser_13",
"listing_path": "course-path-13",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 22,
"name": "Domain Account 30"
},
"type": "Course",
"title": "Course 13",
"list_order": null,
"waitlist": false,
"waitlist_cap": null,
"sku": "sku_10",
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [],
"listing_url": "http://www.my-catalog.edu/courses/course-path-13",
"start_date": "2025/03/21 13:11:23 +0000",
"end_date": "2025/04/04 13:11:23 +0000",
"canvas_section_id": null,
"associated_account_ids": [],
"canvas_course": {
"id": 10
}
}
]
}
]
}POST /api/v1/programs HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 514
{
"program": {
"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",
"requirement_ids": "text",
"sequential": "text"
}
}Creating a program
{
"program": {
"id": 21,
"visibility": "listed",
"enrollment_open": true,
"enrollment_open_from": null,
"enrollment_open_to": null,
"enrollment_cap": 150,
"description": "This is a very awesome program.",
"enrollment_fee": 49.99,
"created_at": "2025/03/28 13:11:23 +0000",
"credits": null,
"measurement": "credit",
"updated_at": "2025/03/28 13:11:23 +0000",
"short_description": "This is an example teaser",
"listing_path": "program-1",
"listing_image": null,
"currency": "USD",
"catalog": {
"id": 25,
"name": "Domain Account 33"
},
"type": "Program",
"title": "Program 1",
"list_order": 123,
"waitlist": true,
"waitlist_cap": 12,
"sku": null,
"show_free_banner": true,
"image_alt_text": null,
"allowed_payment_types": [
"standard"
],
"tag_names": [
"Tag",
"Another Tag"
],
"listing_url": "http://www.my-catalog.edu/programs/program-1",
"start_date": null,
"end_date": null,
"canvas_section_id": null,
"associated_account_ids": [],
"sequential": true,
"requirements": []
}
}PUT /api/v1/programs/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 514
{
"program": {
"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",
"requirement_ids": "text",
"sequential": "text"
}
}Updating a program
{}