For the complete documentation index, see llms.txt. This page is also available as Markdown.

Courses

List courses

get
Authorizations
AuthorizationstringRequired
Query parameters
querystringOptional

General search query (title OR description OR tags)

titlestringOptional

Search by title

tag_namestringOptional

Search by tag name

is_enrollablebooleanOptional

Filter by whether currently open for enrollment

account_idintegerOptional

Filter by account id (must be the current account or one of its subcatalogs)

include_descendant_accountsbooleanOptional

When used with account_id, also include listings from that account's descendant subcatalogs

Responses
200

courses listed

application/json
get/api/v1/courses
GET /api/v1/courses HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
200

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"
    }
  ]
}

Create a course

post

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).

Authorizations
AuthorizationstringRequired
Body
Responses
201

course created

application/json
post/api/v1/courses
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"
  }
}

Get a specific course

get
Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Identifier for this course

Responses
200

course found

application/json
get/api/v1/courses/{id}
GET /api/v1/courses/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
200

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"
  }
}

Update a course

put

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.

Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Identifier for this course

Body
Responses
204

course updated

No content

put/api/v1/courses/{id}
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

Delete a course

delete
Authorizations
AuthorizationstringRequired
Path parameters
idintegerRequired

Identifier for this course

Responses
204

course deleted

No content

delete/api/v1/courses/{id}
DELETE /api/v1/courses/{id} HTTP/1.1
Host: catalog.example.edu
Authorization: YOUR_API_KEY
Accept: */*
204

course deleted

No content

Archive or reactivate courses

put
Authorizations
AuthorizationstringRequired
Body
product_actionstringRequired

Action to perform: archive or reactivate

product_idsinteger[]Required

Product ids to act on

Responses
200

all courses processed

No content

put/api/v1/courses/archived
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

Update course SKUs from CSV

put
Authorizations
AuthorizationstringRequired
Body
string · binaryOptional
Responses
200

SKU import enqueued

No content

put/api/v1/courses/update_skus
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"
200

SKU import enqueued

No content

Last updated

Was this helpful?