Courses

put

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/x-www-form-urlencoded

product_actionstringRequired

Action to perform. Possible values: archive, reactivate

product_idsinteger[]Required

Array of product ids to perform the action on

Responses

200

All courses have been successfully processed

application/json

Responseobject

422

Some courses have failed to process successfully

application/json

put

/api/v1/courses/archived

HTTPcURLJavaScriptPython

PUT /api/v1/courses/archived HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 43

"product_action='text'&product_ids=[1]"

{}

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Query parameters

titlestringOptional

Search by title

descriptionstringOptional

Search by description

listing_pathstringOptional

Search by path

tag_namestringOptional

Search by tag name

is_enrollablestringOptional

Filter by whether the listing is currently open for enrollment (true/false)

querystringOptional

General search query (title OR description OR tags)

Responses

200

Listing courses

application/json

Responseobject

get

/api/v1/courses

HTTPcURLJavaScriptPython

GET /api/v1/courses HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Listing courses

{
  "courses": [
    {
      "id": 39,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_37",
      "enrollment_fee": 0,
      "created_at": "2024/01/01 00:00:00 +0000",
      "credits": 3,
      "measurement": "credit",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "short_description": "teaser_37",
      "listing_path": "course-path-37",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 36,
        "name": "Domain Account 36"
      },
      "type": "Course",
      "title": "Course 37",
      "list_order": null,
      "waitlist": false,
      "waitlist_cap": null,
      "sku": "sku_21",
      "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-37",
      "start_date": "2023/12/25 00:00:00 +0000",
      "end_date": "2024/01/08 00:00:00 +0000",
      "canvas_section_id": null,
      "associated_account_ids": [],
      "archived_at": null,
      "canvas_course": {
        "id": 21
      },
      "instructor_names": [
        "John Doe",
        "Jane Doe"
      ],
      "primary_instructor_name": "Jane Doe"
    },
    {
      "id": 39,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_37",
      "enrollment_fee": 0,
      "created_at": "2024/01/01 00:00:00 +0000",
      "credits": 3,
      "measurement": "credit",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "short_description": "teaser_37",
      "listing_path": "course-path-37",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 36,
        "name": "Domain Account 36"
      },
      "type": "Course",
      "title": "Course 37",
      "list_order": null,
      "waitlist": false,
      "waitlist_cap": null,
      "sku": "sku_21",
      "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-37",
      "start_date": "2023/12/25 00:00:00 +0000",
      "end_date": "2024/01/08 00:00:00 +0000",
      "canvas_section_id": null,
      "associated_account_ids": [],
      "archived_at": null,
      "canvas_course": {
        "id": 21
      },
      "instructor_names": [
        "John Doe",
        "Jane Doe"
      ],
      "primary_instructor_name": "Jane Doe"
    }
  ]
}

post

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

application/json

skustringOptional

Listing SKU

Responses

201

Creating a course

application/json

post

/api/v1/courses

HTTPcURLJavaScriptPython

POST /api/v1/courses HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 612

{
  "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",
    "canvas_section_id": "text",
    "credits": "text",
    "instructor_names": [
      "text"
    ],
    "primary_instructor_name": "text"
  },
  "sku": "text"
}

201

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": "2024/01/01 00:00:00 +0000",
    "credits": 4,
    "measurement": "credit",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "short_description": "This is an example teaser",
    "listing_path": "course-1",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 35,
      "name": "Domain Account 35"
    },
    "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": 20020020,
    "associated_account_ids": [],
    "archived_at": null,
    "canvas_course": {
      "id": 10010010
    },
    "instructor_names": [
      "Jane Doe",
      "John Doe"
    ],
    "primary_instructor_name": "Jane Doe"
  }
}

put

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Body

multipart/form-data

attachmentstring · binaryRequired

CSV containing a Catalog Course ID and Catalog Course SKU header

Responses

200

Updating course sku

application/json

Responseobject

put

/api/v1/courses/update_skus

HTTPcURLJavaScriptPython

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

200

Updating course sku

{
  "progress": {
    "id": 1,
    "account_id": 37,
    "canvas_user_id": null,
    "completion_percent": null,
    "workflow_state": "queued",
    "payload": {},
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000"
  }
}

get

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Responses

200

Getting a specific course

application/json

get

/api/v1/courses/{id}

HTTPcURLJavaScriptPython

GET /api/v1/courses/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

200

Getting a specific course

{
  "course": {
    "id": 41,
    "visibility": "listed",
    "enrollment_open": true,
    "enrollment_open_from": null,
    "enrollment_open_to": null,
    "enrollment_cap": null,
    "description": "description_39",
    "enrollment_fee": 0,
    "created_at": "2024/01/01 00:00:00 +0000",
    "credits": 3,
    "measurement": "credit",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "short_description": "teaser_39",
    "listing_path": "course-path-39",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 39,
      "name": "Domain Account 40"
    },
    "type": "Course",
    "title": "Course 39",
    "list_order": null,
    "waitlist": false,
    "waitlist_cap": null,
    "sku": "sku_23",
    "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-39",
    "start_date": "2023/12/25 00:00:00 +0000",
    "end_date": "2024/01/08 00:00:00 +0000",
    "canvas_section_id": null,
    "associated_account_ids": [],
    "archived_at": null,
    "canvas_course": {
      "id": 23
    },
    "instructor_names": [
      "John Doe",
      "Jane Doe"
    ],
    "primary_instructor_name": "Jane Doe"
  }
}

put

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Body

application/json

skustringOptional

Listing SKU

Responses

204

Updating a course

*/*

put

/api/v1/courses/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/courses/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 612

{
  "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",
    "canvas_section_id": "text",
    "credits": "text",
    "instructor_names": [
      "text"
    ],
    "primary_instructor_name": "text"
  },
  "sku": "text"
}

204

Updating a course

{}

delete

Authorizations

Authorization

AuthorizationstringRequired

API Token based authentication. Use format: Token token="your-api-key"

Path parameters

idintegerRequired

Responses

204

Deleting a specific course

*/*

delete

/api/v1/courses/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/courses/{id} HTTP/1.1
Host: REPLACE_ME
Authorization: YOUR_API_KEY
Accept: */*

204

Deleting a specific course

{}