Programs

get
Authorizations
Path parameters
idintegerRequired
Responses
200
Getting a specific program
application/json
get
GET /api/v1/programs/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200

Getting a specific program

{
  "program": {
    "id": 8,
    "visibility": "listed",
    "enrollment_open": true,
    "enrollment_open_from": null,
    "enrollment_open_to": null,
    "enrollment_cap": null,
    "description": "description_6",
    "enrollment_fee": 0,
    "created_at": "2025/06/10 13:42:02 +0000",
    "credits": 9,
    "measurement": "credit",
    "updated_at": "2025/06/10 13:42:02 +0000",
    "short_description": "teaser_6",
    "listing_path": "program-path-6",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 23,
      "name": "Domain Account 24"
    },
    "type": "Program",
    "title": "Program 6",
    "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-6",
    "start_date": "2025/06/03 13:42:02 +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_7",
        "enrollment_fee": 0,
        "created_at": "2025/06/10 13:42:02 +0000",
        "credits": 3,
        "measurement": "credit",
        "updated_at": "2025/06/10 13:42:02 +0000",
        "short_description": "teaser_7",
        "listing_path": "program-path-7",
        "listing_image": null,
        "currency": "USD",
        "catalog": {
          "id": 23,
          "name": "Domain Account 24"
        },
        "type": "Program",
        "title": "Program 7",
        "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-7",
        "start_date": "2025/06/03 13:42:02 +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_9",
            "enrollment_fee": 0,
            "created_at": "2025/06/10 13:42:02 +0000",
            "credits": 3,
            "measurement": "credit",
            "updated_at": "2025/06/10 13:42:02 +0000",
            "short_description": "teaser_9",
            "listing_path": "course-path-9",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 23,
              "name": "Domain Account 24"
            },
            "type": "Course",
            "title": "Course 9",
            "list_order": null,
            "waitlist": false,
            "waitlist_cap": null,
            "sku": "sku_5",
            "show_free_banner": true,
            "image_alt_text": null,
            "allowed_payment_types": [
              "standard"
            ],
            "tag_names": [],
            "listing_url": "http://www.my-catalog.edu/courses/course-path-9",
            "start_date": "2025/06/03 13:42:02 +0000",
            "end_date": "2025/06/17 13:42:02 +0000",
            "canvas_section_id": null,
            "associated_account_ids": [],
            "canvas_course": {
              "id": 5
            }
          }
        ]
      },
      {
        "id": 10,
        "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/06/10 13:42:02 +0000",
        "credits": 6,
        "measurement": "credit",
        "updated_at": "2025/06/10 13:42:02 +0000",
        "short_description": "teaser_8",
        "listing_path": "program-path-8",
        "listing_image": null,
        "currency": "USD",
        "catalog": {
          "id": 23,
          "name": "Domain Account 24"
        },
        "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": [],
        "listing_url": "http://www.my-catalog.edu/programs/program-path-8",
        "start_date": "2025/06/03 13:42:02 +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_10",
            "enrollment_fee": 0,
            "created_at": "2025/06/10 13:42:02 +0000",
            "credits": 3,
            "measurement": "credit",
            "updated_at": "2025/06/10 13:42:02 +0000",
            "short_description": "teaser_10",
            "listing_path": "course-path-10",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 23,
              "name": "Domain Account 24"
            },
            "type": "Course",
            "title": "Course 10",
            "list_order": null,
            "waitlist": false,
            "waitlist_cap": null,
            "sku": "sku_6",
            "show_free_banner": true,
            "image_alt_text": null,
            "allowed_payment_types": [
              "standard"
            ],
            "tag_names": [],
            "listing_url": "http://www.my-catalog.edu/courses/course-path-10",
            "start_date": "2025/06/03 13:42:02 +0000",
            "end_date": "2025/06/17 13:42:02 +0000",
            "canvas_section_id": null,
            "associated_account_ids": [],
            "canvas_course": {
              "id": 6
            }
          },
          {
            "id": 13,
            "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/06/10 13:42:02 +0000",
            "credits": 3,
            "measurement": "credit",
            "updated_at": "2025/06/10 13:42:02 +0000",
            "short_description": "teaser_11",
            "listing_path": "course-path-11",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 23,
              "name": "Domain Account 24"
            },
            "type": "Course",
            "title": "Course 11",
            "list_order": null,
            "waitlist": false,
            "waitlist_cap": null,
            "sku": "sku_7",
            "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/06/03 13:42:02 +0000",
            "end_date": "2025/06/17 13:42:02 +0000",
            "canvas_section_id": null,
            "associated_account_ids": [],
            "canvas_course": {
              "id": 7
            }
          }
        ]
      }
    ]
  }
}
put
Authorizations
Path parameters
idintegerRequired
Body
Responses
204
Updating a program
*/*
Responseobject
put
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"
  }
}
204

Updating a program

{}
delete
Authorizations
Path parameters
idintegerRequired
Responses
204
Deleting a specific program
*/*
Responseobject
delete
DELETE /api/v1/programs/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
204

Deleting a specific program

{}
get
Authorizations
Responses
200
Listing programs
application/json
Responseobject
get
GET /api/v1/programs HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
200

Listing programs

{
  "programs": [
    {
      "id": 20,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_18",
      "enrollment_fee": 0,
      "created_at": "2025/06/10 13:42:03 +0000",
      "credits": 9,
      "measurement": "credit",
      "updated_at": "2025/06/10 13:42:03 +0000",
      "short_description": "teaser_18",
      "listing_path": "program-path-18",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 25,
        "name": "Domain Account 26"
      },
      "type": "Program",
      "title": "Program 18",
      "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-18",
      "start_date": "2025/06/03 13:42:03 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [],
      "sequential": true,
      "requirements": [
        {
          "id": 21,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_19",
          "enrollment_fee": 0,
          "created_at": "2025/06/10 13:42:03 +0000",
          "credits": 3,
          "measurement": "credit",
          "updated_at": "2025/06/10 13:42:03 +0000",
          "short_description": "teaser_19",
          "listing_path": "program-path-19",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 25,
            "name": "Domain Account 26"
          },
          "type": "Program",
          "title": "Program 19",
          "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-19",
          "start_date": "2025/06/03 13:42:03 +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_21",
              "enrollment_fee": 0,
              "created_at": "2025/06/10 13:42:03 +0000",
              "credits": 3,
              "measurement": "credit",
              "updated_at": "2025/06/10 13:42:03 +0000",
              "short_description": "teaser_21",
              "listing_path": "course-path-21",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 25,
                "name": "Domain Account 26"
              },
              "type": "Course",
              "title": "Course 21",
              "list_order": null,
              "waitlist": false,
              "waitlist_cap": null,
              "sku": "sku_11",
              "show_free_banner": true,
              "image_alt_text": null,
              "allowed_payment_types": [
                "standard"
              ],
              "tag_names": [],
              "listing_url": "http://www.my-catalog.edu/courses/course-path-21",
              "start_date": "2025/06/03 13:42:03 +0000",
              "end_date": "2025/06/17 13:42:03 +0000",
              "canvas_section_id": null,
              "associated_account_ids": [],
              "canvas_course": {
                "id": 11
              }
            }
          ]
        },
        {
          "id": 22,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_20",
          "enrollment_fee": 0,
          "created_at": "2025/06/10 13:42:03 +0000",
          "credits": 6,
          "measurement": "credit",
          "updated_at": "2025/06/10 13:42:03 +0000",
          "short_description": "teaser_20",
          "listing_path": "program-path-20",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 25,
            "name": "Domain Account 26"
          },
          "type": "Program",
          "title": "Program 20",
          "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-20",
          "start_date": "2025/06/03 13:42:03 +0000",
          "end_date": null,
          "canvas_section_id": null,
          "associated_account_ids": [],
          "sequential": true,
          "requirements": [
            {
              "id": 24,
              "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/06/10 13:42:03 +0000",
              "credits": 3,
              "measurement": "credit",
              "updated_at": "2025/06/10 13:42:03 +0000",
              "short_description": "teaser_22",
              "listing_path": "course-path-22",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 25,
                "name": "Domain Account 26"
              },
              "type": "Course",
              "title": "Course 22",
              "list_order": null,
              "waitlist": false,
              "waitlist_cap": null,
              "sku": "sku_12",
              "show_free_banner": true,
              "image_alt_text": null,
              "allowed_payment_types": [
                "standard"
              ],
              "tag_names": [],
              "listing_url": "http://www.my-catalog.edu/courses/course-path-22",
              "start_date": "2025/06/03 13:42:03 +0000",
              "end_date": "2025/06/17 13:42:03 +0000",
              "canvas_section_id": null,
              "associated_account_ids": [],
              "canvas_course": {
                "id": 12
              }
            },
            {
              "id": 25,
              "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/06/10 13:42:03 +0000",
              "credits": 3,
              "measurement": "credit",
              "updated_at": "2025/06/10 13:42:03 +0000",
              "short_description": "teaser_23",
              "listing_path": "course-path-23",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 25,
                "name": "Domain Account 26"
              },
              "type": "Course",
              "title": "Course 23",
              "list_order": null,
              "waitlist": false,
              "waitlist_cap": null,
              "sku": "sku_13",
              "show_free_banner": true,
              "image_alt_text": null,
              "allowed_payment_types": [
                "standard"
              ],
              "tag_names": [],
              "listing_url": "http://www.my-catalog.edu/courses/course-path-23",
              "start_date": "2025/06/03 13:42:03 +0000",
              "end_date": "2025/06/17 13:42:03 +0000",
              "canvas_section_id": null,
              "associated_account_ids": [],
              "canvas_course": {
                "id": 13
              }
            }
          ]
        }
      ]
    },
    {
      "id": 21,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_19",
      "enrollment_fee": 0,
      "created_at": "2025/06/10 13:42:03 +0000",
      "credits": 3,
      "measurement": "credit",
      "updated_at": "2025/06/10 13:42:03 +0000",
      "short_description": "teaser_19",
      "listing_path": "program-path-19",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 25,
        "name": "Domain Account 26"
      },
      "type": "Program",
      "title": "Program 19",
      "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-19",
      "start_date": "2025/06/03 13:42:03 +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_21",
          "enrollment_fee": 0,
          "created_at": "2025/06/10 13:42:03 +0000",
          "credits": 3,
          "measurement": "credit",
          "updated_at": "2025/06/10 13:42:03 +0000",
          "short_description": "teaser_21",
          "listing_path": "course-path-21",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 25,
            "name": "Domain Account 26"
          },
          "type": "Course",
          "title": "Course 21",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": "sku_11",
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [],
          "listing_url": "http://www.my-catalog.edu/courses/course-path-21",
          "start_date": "2025/06/03 13:42:03 +0000",
          "end_date": "2025/06/17 13:42:03 +0000",
          "canvas_section_id": null,
          "associated_account_ids": [],
          "canvas_course": {
            "id": 11
          }
        }
      ]
    },
    {
      "id": 22,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_20",
      "enrollment_fee": 0,
      "created_at": "2025/06/10 13:42:03 +0000",
      "credits": 6,
      "measurement": "credit",
      "updated_at": "2025/06/10 13:42:03 +0000",
      "short_description": "teaser_20",
      "listing_path": "program-path-20",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 25,
        "name": "Domain Account 26"
      },
      "type": "Program",
      "title": "Program 20",
      "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-20",
      "start_date": "2025/06/03 13:42:03 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [],
      "sequential": true,
      "requirements": [
        {
          "id": 24,
          "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/06/10 13:42:03 +0000",
          "credits": 3,
          "measurement": "credit",
          "updated_at": "2025/06/10 13:42:03 +0000",
          "short_description": "teaser_22",
          "listing_path": "course-path-22",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 25,
            "name": "Domain Account 26"
          },
          "type": "Course",
          "title": "Course 22",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": "sku_12",
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [],
          "listing_url": "http://www.my-catalog.edu/courses/course-path-22",
          "start_date": "2025/06/03 13:42:03 +0000",
          "end_date": "2025/06/17 13:42:03 +0000",
          "canvas_section_id": null,
          "associated_account_ids": [],
          "canvas_course": {
            "id": 12
          }
        },
        {
          "id": 25,
          "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/06/10 13:42:03 +0000",
          "credits": 3,
          "measurement": "credit",
          "updated_at": "2025/06/10 13:42:03 +0000",
          "short_description": "teaser_23",
          "listing_path": "course-path-23",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 25,
            "name": "Domain Account 26"
          },
          "type": "Course",
          "title": "Course 23",
          "list_order": null,
          "waitlist": false,
          "waitlist_cap": null,
          "sku": "sku_13",
          "show_free_banner": true,
          "image_alt_text": null,
          "allowed_payment_types": [
            "standard"
          ],
          "tag_names": [],
          "listing_url": "http://www.my-catalog.edu/courses/course-path-23",
          "start_date": "2025/06/03 13:42:03 +0000",
          "end_date": "2025/06/17 13:42:03 +0000",
          "canvas_section_id": null,
          "associated_account_ids": [],
          "canvas_course": {
            "id": 13
          }
        }
      ]
    }
  ]
}
post
Authorizations
Body
Responses
201
Creating a program
application/json
post
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"
  }
}
201

Creating a program

{
  "program": {
    "id": 7,
    "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/06/10 13:42:02 +0000",
    "credits": null,
    "measurement": "credit",
    "updated_at": "2025/06/10 13:42:02 +0000",
    "short_description": "This is an example teaser",
    "listing_path": "program-1",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 22,
      "name": "Domain Account 23"
    },
    "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": []
  }
}

Last updated

Was this helpful?