Catalog JSON API Documentation

So, you want to develop some tooling around the Catalog API - perhaps some custom reports? Great! This API gives you everything that Catalog has to offer.

Authentication

Visit this page to create an API key. Once you’ve received your key, treat it like a password.

Use SSL for all requests to the API. Non-SSL requests will result in redirects, and your API key will be sent in the clear.

To authenticate, send the API key as a request header. Here’s an example using cURL:

curl https://www.my-catalog.edu/api/v1/products -H 'Authorization: Token token="my-api-key"'

Pagination

All index endpoints support pagination. Specifically, we implement RFC5988.

Pagination Options

You can use ?page= to set the page of data you want to retrieve. If no items exist for that page, the response will be a root key with an empty array.

curl https://www.my-catalog.edu/api/v1/courses?page=2

{
  "courses": []
}

To change the number of items returned for each page, you can use ?per_page=. This defaults to 20 and has a max of 100.

curl https://www.my-catalog.edu/api/v1/courses?per_page=40&page=2

Information about pagination is provided in the Link header. Here is an example of what the header could look like

curl -I https://www.my-catalog.edu/api/v1/courses?page=3

Link: <https://www.my-catalog.edu/api/v1/courses?page=4>; rel="next",  
      <https://www.my-catalog.edu/api/v1/courses?page=15>; rel="last",
      <https://www.my-catalog.edu/api/v1/courses?page=1>; rel="first",
      <https://www.my-catalog.edu/api/v1/courses?page=2>; rel="prev"

Let’s talk about what each link means. rel="next" lets us know that the next page of data is page=4. This make sense given that we requested page 3. rel="prev" lets us know that the page previous to the one we requested is page=2. rel="next" indicates the next page of data to request. rel="last" tells us the last and total number of pages of data that currently exist.

Not all rel= links will exist on every response. For instance, the response for the first page of data will not have rel="first" or rel="prev". The same is true for the last page of data. This means that you can programmatically traverse all pages of data by requesting the first page and continuing to request the rel="next" until the response does not contain a rel="next".

It’s important to note that altering the per_page= will change the total number of pages.

Listing Image

If you are uploading a product image in SVG format. You will need to specify the file type.

curl https://www.my-catalog.edu/api/v1/products -F "course[listing_image]=@somefile.svg;type=image/svg+xml"'

Waitlist applicants

Listing applicants

Endpoint

GET https://www.my-catalog.edu/api/v1/applicants

Parameters

Name Description Type
listing_id Only include applicants for the specified listing Integer
status Only include applicants for the specified status (waitlist, accepted, declined, or expired) String

Request

Route

GET https://www.my-catalog.edu/api/v1/applicants

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "applicants": [
    {
      "id": 1,
      "user": {
        "id": 1,
        "name": "Applicant",
        "email": "plz@letmein.com"
      },
      "listing": {
        "id": 1,
        "title": "Course 1"
      },
      "notified_of_opening_at": null,
      "status": "waitlist",
      "created_at": "2024/01/01 00:00:00 +0000",
      "updated_at": "2024/01/01 00:00:00 +0000"
    }
  ]
}

Getting a specific applicant record

Endpoint

GET https://www.my-catalog.edu/api/v1/applicants/:id

Request

Route

GET https://www.my-catalog.edu/api/v1/applicants/2

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Identifier for this applicant Integer
listing[id] Identifier for listing Integer
listing[title] Listing title String
user[id] User ID Integer
user[name] Full name String
user[email] E-mail address String
status Status (waitlist, accepted, expired, or error) String
notified_of_opening_at Time user was notified of opening Datetime
created_at The creation date for the applicant Datetime
updated_at The last time the applicant was updated Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "applicant": {
    "id": 2,
    "user": {
      "id": 2,
      "name": "Applicant",
      "email": "plz@letmein.com"
    },
    "listing": {
      "id": 2,
      "title": "Course 2"
    },
    "notified_of_opening_at": null,
    "status": "waitlist",
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000"
  }
}

Delete applicants

Endpoint

DELETE https://www.my-catalog.edu/api/v1/applicants

Parameters

Name Description Type
listing_id required Only delete applicants for the specified listing Integer
canvas_user_id Only delete applicants with the specified canvas user id if specified Integer

Request

Route

DELETE https://www.my-catalog.edu/api/v1/applicants

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu
Content-Type: application/x-www-form-urlencoded

Body

listing_id=3

Response

Status

204

Orders

Getting a specific order

Endpoint

GET https://www.my-catalog.edu/api/v1/orders/:id

Request

Route

GET https://www.my-catalog.edu/api/v1/orders/1

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Identifier for this order. Integer
full_id Full ID for this order, including prefix. String
catalog_id DEPRECATED: Use catalog['id'] instead. Integer
catalog[id] Identifier for the catalog the order is linked to Integer
catalog[name] Name of the catalog this order is linked to String
user[id] Canvas ID of the user who placed the order Integer
user[name] Name of the user who placed the order String
user[email] E-mail address of the user who placed the order String
listings Array of purchased listings (courses and programs). Fields below: Array
listing[id] Identifier for a listing purchased with this order Integer
listing[catalog_id] Catalog ID associated to this listing Integer
listing[canvas_course_id] Canvas course ID associated to this listing Integer|null
listing[title] The name of the listing String
listing[amount] Listing price at the time of purchase Decimal
listing[discounted_amount] Discounted price by promotions Decimal
promotions Array of promotions used. Fields below: Array
promotion[id] Identifier for a promotion used with this order Integer
promotion[listing_id] Identifier for the listing this promotion is used for Integer
promotion[code] Promo code used for this order String
promotion[amount] Discount amount Decimal
payments Array of payments. Fields below: Array
payment[reference_id] Identifier from the payment redirector String
payment[status] Status of the payment. Can be success, error, or pending. String
payment[amount] Amount of the payment Decimal
total Total cost charged to the user Decimal
currency Currency used for the transaction String
purchased_at Time the transaction was successfully completed. This field is nil for unsuccessful or unpaid orders. Datetime
created_at Time the order was initiated. Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "order": {
    "id": 1,
    "full_id": "1",
    "catalog_id": 4,
    "catalog": {
      "id": 4,
      "name": "Domain Account 4"
    },
    "user": {
      "id": 1,
      "name": "Saul Goodman",
      "email": "bettercall@saul.com"
    },
    "listings": [
      {
        "id": 4,
        "canvas_course_id": 4,
        "title": "Course 4",
        "amount": "100.0",
        "discounted_amount": "90.0",
        "catalog_id": 4
      }
    ],
    "promotions": [
      {
        "id": 1,
        "listing_id": 4,
        "code": "PROMO1",
        "amount": "-10.0"
      }
    ],
    "payments": [
      {
        "reference_id": "123",
        "status": "success",
        "amount": "90.0"
      }
    ],
    "total": "90.0",
    "currency": "USD",
    "purchased_at": "2024/01/01 00:00:00 +0000",
    "created_at": "2024/01/01 00:00:00 +0000"
  }
}

Listing orders

Endpoint

GET https://www.my-catalog.edu/api/v1/orders

Parameters

Name Description Type
from Earliest date/time to return. Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC. DateTime
to Latest date/time to return. See 'from' above for format. DateTime
canvas_user_id Return only orders for the specified Canvas user ID Integer
completed When set, only return orders that were completed successfully Boolean

Request

Route

GET https://www.my-catalog.edu/api/v1/orders

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "orders": [
    {
      "id": 2,
      "full_id": "2",
      "catalog_id": 5,
      "catalog": {
        "id": 5,
        "name": "Domain Account 5"
      },
      "user": {
        "id": 1,
        "name": "Saul Goodman",
        "email": "bettercall@saul.com"
      },
      "listings": [
        {
          "id": 5,
          "canvas_course_id": 5,
          "title": "Course 5",
          "amount": "100.0",
          "discounted_amount": "90.0",
          "catalog_id": 5
        }
      ],
      "promotions": [
        {
          "id": 2,
          "listing_id": 5,
          "code": "PROMO2",
          "amount": "-10.0"
        }
      ],
      "payments": [
        {
          "reference_id": "123",
          "status": "success",
          "amount": "90.0"
        }
      ],
      "total": "90.0",
      "currency": "USD",
      "purchased_at": "2024/01/01 00:00:00 +0000",
      "created_at": "2024/01/01 00:00:00 +0000"
    }
  ]
}

Bulk enrollments

Getting a specific bulk enrollment

Endpoint

GET https://www.my-catalog.edu/api/v1/order_items/history/bulk_enrollments/:id

Parameters

Name Description Type
id required Order id Integer

Request

Route

GET https://www.my-catalog.edu/api/v1/order_items/history/bulk_enrollments/3

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "bulk_purchase": {
    "order": {
      "id": 3,
      "created_at": "2024-12-20T12:12:29.066827Z",
      "updated_at": "2024-12-20T12:12:30.892895Z",
      "full_id": "3",
      "account_id": 6,
      "user_id": 187,
      "canvas_user_id": 1,
      "canvas_root_account_uuid": "6WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
      "source": "bulk_purchase",
      "currency": "USD",
      "purchased_at": "2024-12-20T12:12:30.892045Z",
      "total": 6.0,
      "email": "bettercall@saul.com",
      "name": "Saul Goodman",
      "items": [
        {
          "id": 61,
          "created_at": "2024-12-20T12:12:29.068419Z",
          "updated_at": "2024-12-20T12:12:29.068433Z",
          "order_id": 3,
          "item_id": 42,
          "amount": 15.0,
          "canvas_root_account_uuid": "6WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
          "discounted_amount": 6.0,
          "quantity": 3,
          "unit_price": 5.0
        }
      ]
    },
    "product": {
      "id": 42,
      "visibility": "listed",
      "enrollment_open": true,
      "title": "Paid program",
      "enrollment_fee": 5,
      "account_id": 6,
      "type": "Program",
      "canvas_root_account_uuid": "6WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
      "waitlist": false,
      "limited": false,
      "started": false,
      "program": true,
      "course": false,
      "ended": false
    },
    "bulk_invitations": [
      {
        "order_item_id": 61,
        "invitation_id": 4,
        "status": "created"
      },
      {
        "order_item_id": 61,
        "invitation_id": 5,
        "status": "created"
      },
      {
        "order_item_id": 61,
        "invitation_id": 6,
        "status": "created"
      }
    ]
  }
}

Listing bulk enrollments

Endpoint

GET https://www.my-catalog.edu/api/v1/order_items/history/bulk_enrollments

Parameters

Name Description Type
from Only include bulk enrollments from this date DateTime
to Only include bulk enrollments to this date DateTime
canvas_user_ids Only include bulk enrollments for the specified canvas user ids Array

Request

Route

GET https://www.my-catalog.edu/api/v1/order_items/history/bulk_enrollments

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "bulk_enrollments": [
    {
      "bulk_purchase": {
        "order": {
          "id": 4,
          "created_at": "2024-12-20T12:12:29.066827Z",
          "updated_at": "2024-12-20T12:12:30.892895Z",
          "full_id": "4",
          "account_id": 8,
          "user_id": 187,
          "canvas_user_id": 1,
          "canvas_root_account_uuid": "8WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
          "source": "bulk_purchase",
          "currency": "USD",
          "purchased_at": "2024-12-20T12:12:30.892045Z",
          "total": 6.0,
          "email": "bettercall@saul.com",
          "name": "Saul Goodman",
          "items": [
            {
              "id": 61,
              "created_at": "2024-12-20T12:12:29.068419Z",
              "updated_at": "2024-12-20T12:12:29.068433Z",
              "order_id": 4,
              "item_id": 42,
              "amount": 15.0,
              "canvas_root_account_uuid": "8WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
              "discounted_amount": 6.0,
              "quantity": 3,
              "unit_price": 5.0
            }
          ]
        },
        "product": {
          "id": 42,
          "visibility": "listed",
          "enrollment_open": true,
          "title": "Paid program",
          "enrollment_fee": 5,
          "account_id": 8,
          "type": "Program",
          "canvas_root_account_uuid": "8WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
          "waitlist": false,
          "limited": false,
          "started": false,
          "program": true,
          "course": false,
          "ended": false
        },
        "bulk_invitations": [
          {
            "order_item_id": 61,
            "invitation_id": 4,
            "status": "created"
          },
          {
            "order_item_id": 61,
            "invitation_id": 5,
            "status": "created"
          },
          {
            "order_item_id": 61,
            "invitation_id": 6,
            "status": "created"
          }
        ]
      }
    }
  ]
}

User registrations

Getting a specific user registration

DEPRECATED: use users resource instead. It has all data from the current API endpoint.
GET /api/v1/users?canvas_user_id=:id is providing similar data

Endpoint

GET https://www.my-catalog.edu/api/v1/user_registrations/:id

Parameters

Name Description
id Canvas user ID

Request

Route

GET https://www.my-catalog.edu/api/v1/user_registrations/1

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
canvas_user_id Canvas user ID Integer
name Full name String
email E-mail address String
custom_fields Custom field values, e.g. { 'phone': '(999) 123-4567' } Object
created_at Date/time registration was recorded Datetime
updated_at Date/time last updated Datetime
catalog[id] Id for the catalog this user registered for Integer
catalog[name] Name for the catalog this user registered for String

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "user_registration": {
    "canvas_user_id": 1,
    "catalog": {
      "id": 10,
      "name": "Domain Account 10"
    },
    "name": "User 1",
    "email": "user1@example.com",
    "custom_fields": {
      "favorite_color": "#BADA55",
      "code_of_conduct": "1",
      "age": "19"
    },
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000"
  }
}

Listing user registrations

DEPRECATED: use users resource instead. It has all data from the current API endpoint.
GET /api/v1/users?registered_in_catalog=true is providing similar data

Endpoint

GET https://www.my-catalog.edu/api/v1/user_registrations

Parameters

Name Description
from Earliest date/time to return (optional, String). Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC.
to Latest date/time to return (optional, String). See 'from' above for format.

Request

Route

GET https://www.my-catalog.edu/api/v1/user_registrations

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "user_registrations": [
    {
      "canvas_user_id": 2,
      "catalog": {
        "id": 11,
        "name": "Domain Account 11"
      },
      "name": "User 2",
      "email": "user2@example.com",
      "custom_fields": {
        "favorite_color": "#BADA55",
        "code_of_conduct": "1",
        "age": "19"
      },
      "created_at": "2024/01/01 00:00:00 +0000",
      "updated_at": "2024/01/01 00:00:00 +0000"
    }
  ]
}

Registering a user

DEPRECATED: use users resource instead. It has all data from the current API endpoint.
POST /api/v1/users is providing similar behavior

Endpoint

POST https://www.my-catalog.edu/api/v1/user_registrations

Parameters

Name Description
name Full name
email E-mail address (will also serve as login)
catalog_id ID of subcatalog to associate with user (optional)
custom_fields Hash of custom field values, e.g. { 'phone': '867-5309' } (optional)

Request

Route

POST https://www.my-catalog.edu/api/v1/user_registrations

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "user_registration": {
    "name": "Barack Obama",
    "email": "barack@obama.com",
    "custom_fields": {
      "phone": "(999) 123-4567"
    }
  }
}

Response

Response Fields

Name Description Type
canvas_user_id Canvas user ID Integer
name Full name String
email E-mail address String
custom_fields Custom field values, e.g. { 'phone': '(999) 123-4567' } Object
created_at Date/time registration was recorded Datetime
updated_at Date/time last updated Datetime
catalog[id] Id for the catalog this user registered for Integer
catalog[name] Name for the catalog this user registered for String

Status

201

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "user_registration": {
    "canvas_user_id": 1234,
    "catalog": {
      "id": 12,
      "name": "Domain Account 12"
    },
    "name": "Barack Obama",
    "email": "barack@obama.com",
    "custom_fields": {
    },
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000"
  }
}

Programs

Some programs have failed to process successfully

Endpoint

PUT https://www.my-catalog.edu/api/v1/programs/archived

Parameters

Name Description Type
product_action required Action to perform. Possible values: archive, reactivate String
product_ids required Array of product ids to perform the action on Array

Request

Route

PUT https://www.my-catalog.edu/api/v1/programs/archived

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "product_action": "archive",
  "product_ids": [
    6,
    7,
    8,
    9
  ],
  "reason": "End of semester"
}

Response

Status

422

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "error": "Some products could not be archived",
  "details": {
    "product_ids": [
      9
    ]
  }
}

All programs have been successfully processed

Endpoint

PUT https://www.my-catalog.edu/api/v1/programs/archived

Parameters

Name Description Type
product_action required Action to perform. Possible values: archive, reactivate String
product_ids required Array of product ids to perform the action on Array

Request

Route

PUT https://www.my-catalog.edu/api/v1/programs/archived

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "product_action": "archive",
  "product_ids": [
    10,
    11
  ],
  "reason": "End of semester"
}

Response

Status

200

Headers

Content-Type: application/json

Getting a specific program

Endpoint

GET https://www.my-catalog.edu/api/v1/programs/:id

Request

Route

GET https://www.my-catalog.edu/api/v1/programs/12

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Identifier for this listing. Integer
visibility Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
enrollment_open Open for enrollment Boolean
enrollment_open_from If specified, enrollment is open only from this date-time Datetime
enrollment_open_to If specified, enrollment is open only to this date-time Datetime
enrollment_cap A limit for the total number of enrollments Integer
waitlist Waitlist enabled Boolean
waitlist_cap Wait List Limit for the total number of wait listed enrollments Integer
title Title of the listing String
enrollment_fee Enrollment fee Decimal
currency The three digit currency code associated to the enrollment fee String
listing_path Path to the listing. Used in URLs String
listing_url The URL of the listing String
short_description A short description for this listing String
list_order Order in which the listing is listed in the catalog Integer
tag_names List of tags applied to this listing Array
detail_code Payment detail code for a course (only if enabled with :payment_detail_code_enabled feature flag) String
show_free_banner Show the 'FREE' mark on the card of the listing if free Boolean
associated_account_ids Other account ids where this product should be listed Array
start_date When the Canvas course starts if specified Datetime
end_date When the Canvas course ends if specified Datetime
canvas_section_id The Canvas course's section's id Integer
catalog[id] Id for the catalog that owns this listing Integer
catalog[name] Name for the catalog that owns this listing String
created_at The creation date for the listing. Datetime
updated_at The last time the listing was updated. Datetime
sku Listing SKU String
archived_at Archival date (null if product is not archived) Datetime
sequential Indicates if students are required to complete requirements in order Boolean
requirements A nested array of the programs requirements. This includes courses and subprograms which can be distinguished by the type key. Array
credits Cumulative credit value of the program's requirements Decimal

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "program": {
    "id": 12,
    "visibility": "listed",
    "enrollment_open": true,
    "enrollment_open_from": null,
    "enrollment_open_to": null,
    "enrollment_cap": null,
    "description": "description_12",
    "enrollment_fee": 0.0,
    "created_at": "2024/01/01 00:00:00 +0000",
    "credits": 9.0,
    "measurement": "credit",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "short_description": "teaser_12",
    "listing_path": "program-path-12",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 15,
      "name": "Domain Account 15"
    },
    "type": "Program",
    "title": "Program 12",
    "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-12",
    "start_date": "2023/12/25 00:00:00 +0000",
    "end_date": null,
    "canvas_section_id": null,
    "associated_account_ids": [

    ],
    "archived_at": null,
    "sequential": true,
    "requirements": [
      {
        "id": 13,
        "visibility": "listed",
        "enrollment_open": true,
        "enrollment_open_from": null,
        "enrollment_open_to": null,
        "enrollment_cap": null,
        "description": "description_13",
        "enrollment_fee": 0.0,
        "created_at": "2024/01/01 00:00:00 +0000",
        "credits": 3.0,
        "measurement": "credit",
        "updated_at": "2024/01/01 00:00:00 +0000",
        "short_description": "teaser_13",
        "listing_path": "program-path-13",
        "listing_image": null,
        "currency": "USD",
        "catalog": {
          "id": 15,
          "name": "Domain Account 15"
        },
        "type": "Program",
        "title": "Program 13",
        "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-13",
        "start_date": "2023/12/25 00:00:00 +0000",
        "end_date": null,
        "canvas_section_id": null,
        "associated_account_ids": [

        ],
        "archived_at": null,
        "sequential": true,
        "requirements": [
          {
            "id": 15,
            "visibility": "listed",
            "enrollment_open": true,
            "enrollment_open_from": null,
            "enrollment_open_to": null,
            "enrollment_cap": null,
            "description": "description_15",
            "enrollment_fee": 0.0,
            "created_at": "2024/01/01 00:00:00 +0000",
            "credits": 3.0,
            "measurement": "credit",
            "updated_at": "2024/01/01 00:00:00 +0000",
            "short_description": "teaser_15",
            "listing_path": "course-path-15",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 15,
              "name": "Domain Account 15"
            },
            "type": "Course",
            "title": "Course 15",
            "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-15",
            "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": 6
            },
            "instructor_names": [

            ],
            "primary_instructor_name": null
          }
        ]
      },
      {
        "id": 14,
        "visibility": "listed",
        "enrollment_open": true,
        "enrollment_open_from": null,
        "enrollment_open_to": null,
        "enrollment_cap": null,
        "description": "description_14",
        "enrollment_fee": 0.0,
        "created_at": "2024/01/01 00:00:00 +0000",
        "credits": 6.0,
        "measurement": "credit",
        "updated_at": "2024/01/01 00:00:00 +0000",
        "short_description": "teaser_14",
        "listing_path": "program-path-14",
        "listing_image": null,
        "currency": "USD",
        "catalog": {
          "id": 15,
          "name": "Domain Account 15"
        },
        "type": "Program",
        "title": "Program 14",
        "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-14",
        "start_date": "2023/12/25 00:00:00 +0000",
        "end_date": null,
        "canvas_section_id": null,
        "associated_account_ids": [

        ],
        "archived_at": null,
        "sequential": true,
        "requirements": [
          {
            "id": 16,
            "visibility": "listed",
            "enrollment_open": true,
            "enrollment_open_from": null,
            "enrollment_open_to": null,
            "enrollment_cap": null,
            "description": "description_16",
            "enrollment_fee": 0.0,
            "created_at": "2024/01/01 00:00:00 +0000",
            "credits": 3.0,
            "measurement": "credit",
            "updated_at": "2024/01/01 00:00:00 +0000",
            "short_description": "teaser_16",
            "listing_path": "course-path-16",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 15,
              "name": "Domain Account 15"
            },
            "type": "Course",
            "title": "Course 16",
            "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-16",
            "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": 7
            },
            "instructor_names": [

            ],
            "primary_instructor_name": null
          },
          {
            "id": 17,
            "visibility": "listed",
            "enrollment_open": true,
            "enrollment_open_from": null,
            "enrollment_open_to": null,
            "enrollment_cap": null,
            "description": "description_17",
            "enrollment_fee": 0.0,
            "created_at": "2024/01/01 00:00:00 +0000",
            "credits": 3.0,
            "measurement": "credit",
            "updated_at": "2024/01/01 00:00:00 +0000",
            "short_description": "teaser_17",
            "listing_path": "course-path-17",
            "listing_image": null,
            "currency": "USD",
            "catalog": {
              "id": 15,
              "name": "Domain Account 15"
            },
            "type": "Course",
            "title": "Course 17",
            "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-17",
            "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": 8
            },
            "instructor_names": [

            ],
            "primary_instructor_name": null
          }
        ]
      }
    ]
  }
}

Deleting a specific program

Endpoint

DELETE https://www.my-catalog.edu/api/v1/programs/:id

Request

Route

DELETE https://www.my-catalog.edu/api/v1/programs/18

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu
Content-Type: application/x-www-form-urlencoded

Response

Status

204

Listing programs

Endpoint

GET https://www.my-catalog.edu/api/v1/programs

Request

Route

GET https://www.my-catalog.edu/api/v1/programs

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "programs": [
    {
      "id": 24,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_24",
      "enrollment_fee": 0.0,
      "created_at": "2024/01/01 00:00:00 +0000",
      "credits": 9.0,
      "measurement": "credit",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "short_description": "teaser_24",
      "listing_path": "program-path-24",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 17,
        "name": "Domain Account 17"
      },
      "type": "Program",
      "title": "Program 24",
      "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-24",
      "start_date": "2023/12/25 00:00:00 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [

      ],
      "archived_at": null,
      "sequential": true,
      "requirements": [
        {
          "id": 25,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_25",
          "enrollment_fee": 0.0,
          "created_at": "2024/01/01 00:00:00 +0000",
          "credits": 3.0,
          "measurement": "credit",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "short_description": "teaser_25",
          "listing_path": "program-path-25",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 17,
            "name": "Domain Account 17"
          },
          "type": "Program",
          "title": "Program 25",
          "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-25",
          "start_date": "2023/12/25 00:00:00 +0000",
          "end_date": null,
          "canvas_section_id": null,
          "associated_account_ids": [

          ],
          "archived_at": null,
          "sequential": true,
          "requirements": [
            {
              "id": 27,
              "visibility": "listed",
              "enrollment_open": true,
              "enrollment_open_from": null,
              "enrollment_open_to": null,
              "enrollment_cap": null,
              "description": "description_27",
              "enrollment_fee": 0.0,
              "created_at": "2024/01/01 00:00:00 +0000",
              "credits": 3.0,
              "measurement": "credit",
              "updated_at": "2024/01/01 00:00:00 +0000",
              "short_description": "teaser_27",
              "listing_path": "course-path-27",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 17,
                "name": "Domain Account 17"
              },
              "type": "Course",
              "title": "Course 27",
              "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-27",
              "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": 12
              },
              "instructor_names": [

              ],
              "primary_instructor_name": null
            }
          ]
        },
        {
          "id": 26,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_26",
          "enrollment_fee": 0.0,
          "created_at": "2024/01/01 00:00:00 +0000",
          "credits": 6.0,
          "measurement": "credit",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "short_description": "teaser_26",
          "listing_path": "program-path-26",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 17,
            "name": "Domain Account 17"
          },
          "type": "Program",
          "title": "Program 26",
          "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-26",
          "start_date": "2023/12/25 00:00:00 +0000",
          "end_date": null,
          "canvas_section_id": null,
          "associated_account_ids": [

          ],
          "archived_at": null,
          "sequential": true,
          "requirements": [
            {
              "id": 28,
              "visibility": "listed",
              "enrollment_open": true,
              "enrollment_open_from": null,
              "enrollment_open_to": null,
              "enrollment_cap": null,
              "description": "description_28",
              "enrollment_fee": 0.0,
              "created_at": "2024/01/01 00:00:00 +0000",
              "credits": 3.0,
              "measurement": "credit",
              "updated_at": "2024/01/01 00:00:00 +0000",
              "short_description": "teaser_28",
              "listing_path": "course-path-28",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 17,
                "name": "Domain Account 17"
              },
              "type": "Course",
              "title": "Course 28",
              "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-28",
              "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": 13
              },
              "instructor_names": [

              ],
              "primary_instructor_name": null
            },
            {
              "id": 29,
              "visibility": "listed",
              "enrollment_open": true,
              "enrollment_open_from": null,
              "enrollment_open_to": null,
              "enrollment_cap": null,
              "description": "description_29",
              "enrollment_fee": 0.0,
              "created_at": "2024/01/01 00:00:00 +0000",
              "credits": 3.0,
              "measurement": "credit",
              "updated_at": "2024/01/01 00:00:00 +0000",
              "short_description": "teaser_29",
              "listing_path": "course-path-29",
              "listing_image": null,
              "currency": "USD",
              "catalog": {
                "id": 17,
                "name": "Domain Account 17"
              },
              "type": "Course",
              "title": "Course 29",
              "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-29",
              "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": 14
              },
              "instructor_names": [

              ],
              "primary_instructor_name": null
            }
          ]
        }
      ]
    },
    {
      "id": 25,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_25",
      "enrollment_fee": 0.0,
      "created_at": "2024/01/01 00:00:00 +0000",
      "credits": 3.0,
      "measurement": "credit",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "short_description": "teaser_25",
      "listing_path": "program-path-25",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 17,
        "name": "Domain Account 17"
      },
      "type": "Program",
      "title": "Program 25",
      "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-25",
      "start_date": "2023/12/25 00:00:00 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [

      ],
      "archived_at": null,
      "sequential": true,
      "requirements": [
        {
          "id": 27,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_27",
          "enrollment_fee": 0.0,
          "created_at": "2024/01/01 00:00:00 +0000",
          "credits": 3.0,
          "measurement": "credit",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "short_description": "teaser_27",
          "listing_path": "course-path-27",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 17,
            "name": "Domain Account 17"
          },
          "type": "Course",
          "title": "Course 27",
          "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-27",
          "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": 12
          },
          "instructor_names": [

          ],
          "primary_instructor_name": null
        }
      ]
    },
    {
      "id": 26,
      "visibility": "listed",
      "enrollment_open": true,
      "enrollment_open_from": null,
      "enrollment_open_to": null,
      "enrollment_cap": null,
      "description": "description_26",
      "enrollment_fee": 0.0,
      "created_at": "2024/01/01 00:00:00 +0000",
      "credits": 6.0,
      "measurement": "credit",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "short_description": "teaser_26",
      "listing_path": "program-path-26",
      "listing_image": null,
      "currency": "USD",
      "catalog": {
        "id": 17,
        "name": "Domain Account 17"
      },
      "type": "Program",
      "title": "Program 26",
      "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-26",
      "start_date": "2023/12/25 00:00:00 +0000",
      "end_date": null,
      "canvas_section_id": null,
      "associated_account_ids": [

      ],
      "archived_at": null,
      "sequential": true,
      "requirements": [
        {
          "id": 28,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_28",
          "enrollment_fee": 0.0,
          "created_at": "2024/01/01 00:00:00 +0000",
          "credits": 3.0,
          "measurement": "credit",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "short_description": "teaser_28",
          "listing_path": "course-path-28",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 17,
            "name": "Domain Account 17"
          },
          "type": "Course",
          "title": "Course 28",
          "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-28",
          "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": 13
          },
          "instructor_names": [

          ],
          "primary_instructor_name": null
        },
        {
          "id": 29,
          "visibility": "listed",
          "enrollment_open": true,
          "enrollment_open_from": null,
          "enrollment_open_to": null,
          "enrollment_cap": null,
          "description": "description_29",
          "enrollment_fee": 0.0,
          "created_at": "2024/01/01 00:00:00 +0000",
          "credits": 3.0,
          "measurement": "credit",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "short_description": "teaser_29",
          "listing_path": "course-path-29",
          "listing_image": null,
          "currency": "USD",
          "catalog": {
            "id": 17,
            "name": "Domain Account 17"
          },
          "type": "Course",
          "title": "Course 29",
          "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-29",
          "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": 14
          },
          "instructor_names": [

          ],
          "primary_instructor_name": null
        }
      ]
    }
  ]
}

Creating a program

Endpoint

POST https://www.my-catalog.edu/api/v1/programs

Parameters

Name Description Type
program[title] required Listing title String
program[description] required Full listing description String
program[path] required Path to the listing. Used in URLs String
program[teaser] required A shorter description of the listing String
program[enrollment_open] Indicates if the listing is current accepting new students Boolean
program[enrollment_open_from] If specified, enrollment is open only from this date-time Datetime
program[enrollment_open_to] If specified, enrollment is open only to this date-time Datetime
program[visibility] Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
program[enrollment_cap] A limit for the total number of enrollments Integer
program[enrollment_fee] Enrollment fee Decimal
program[allowed_payment_types] Allowed payment methods Array
program[days_to_complete] The number of days a student has to complete the requirements Integer
program[account_id] The id of the account to associate the listing to. Can be an id of any subcatalog of the catalog making the API request. Defaults to the catalog making the API request. Integer
program[list_order] Order in which the listing is shown in the catalog Integer
program[waitlist] Waitlist enabled (defaults to false) Boolean
program[waitlist_cap] Wait List Limit for the total number of wait listed enrollments Integer
program[listing_image] URL or file upload for the image to be shown with this listing. String
program[tag_names] List of tags applied to this listing Array
program[show_free_banner] Show the 'FREE' mark on the card of the listing if free Boolean
program[associated_account_ids] Other account ids where this product should be listed Array
sku Listing SKU String
program[requirement_ids] Ordered array of listing IDs that represent requirements for completing the program Array
program[sequential] Indicates if students are required to complete requirements in order Boolean

Request

Route

POST https://www.my-catalog.edu/api/v1/programs

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "program": {
    "title": "Program 1",
    "description": "This is a very awesome program.",
    "path": "program-1",
    "teaser": "This is an example teaser",
    "enrollment_open": true,
    "visibility": "listed",
    "enrollment_cap": 150,
    "waitlist": true,
    "waitlist_cap": 12,
    "enrollment_fee": 49.99,
    "days_to_complete": 45,
    "list_order": 123,
    "requirement_ids": [

    ],
    "sequential": true,
    "sku": "abc1234",
    "tag_names": [
      "Tag",
      "Another Tag"
    ]
  }
}

Response

Response Fields

Name Description Type
id Identifier for this listing. Integer
visibility Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
enrollment_open Open for enrollment Boolean
enrollment_open_from If specified, enrollment is open only from this date-time Datetime
enrollment_open_to If specified, enrollment is open only to this date-time Datetime
enrollment_cap A limit for the total number of enrollments Integer
waitlist Waitlist enabled Boolean
waitlist_cap Wait List Limit for the total number of wait listed enrollments Integer
title Title of the listing String
enrollment_fee Enrollment fee Decimal
currency The three digit currency code associated to the enrollment fee String
listing_path Path to the listing. Used in URLs String
listing_url The URL of the listing String
short_description A short description for this listing String
list_order Order in which the listing is listed in the catalog Integer
tag_names List of tags applied to this listing Array
detail_code Payment detail code for a course (only if enabled with :payment_detail_code_enabled feature flag) String
show_free_banner Show the 'FREE' mark on the card of the listing if free Boolean
associated_account_ids Other account ids where this product should be listed Array
start_date When the Canvas course starts if specified Datetime
end_date When the Canvas course ends if specified Datetime
canvas_section_id The Canvas course's section's id Integer
catalog[id] Id for the catalog that owns this listing Integer
catalog[name] Name for the catalog that owns this listing String
created_at The creation date for the listing. Datetime
updated_at The last time the listing was updated. Datetime
sku Listing SKU String
archived_at Archival date (null if product is not archived) Datetime
sequential Indicates if students are required to complete requirements in order Boolean
requirements A nested array of the programs requirements. This includes courses and subprograms which can be distinguished by the type key. Array
credits Cumulative credit value of the program's requirements Decimal

Status

201

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "program": {
    "id": 30,
    "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": "2024/01/01 00:00:00 +0000",
    "credits": null,
    "measurement": "credit",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "short_description": "This is an example teaser",
    "listing_path": "program-1",
    "listing_image": null,
    "currency": "USD",
    "catalog": {
      "id": 18,
      "name": "Domain Account 18"
    },
    "type": "Program",
    "title": "Program 1",
    "list_order": 123,
    "waitlist": true,
    "waitlist_cap": 12,
    "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/programs/program-1",
    "start_date": null,
    "end_date": null,
    "canvas_section_id": null,
    "associated_account_ids": [

    ],
    "archived_at": null,
    "sequential": true,
    "requirements": [

    ]
  }
}

Updating a program

Endpoint

PUT https://www.my-catalog.edu/api/v1/programs/:id

Parameters

Name Description Type
program[title] Listing title String
program[description] Full listing description String
program[path] Path to the listing. Used in URLs String
program[teaser] A shorter description of the listing String
program[enrollment_open] Indicates if the listing is current accepting new students Boolean
program[enrollment_open_from] If specified, enrollment is open only from this date-time Datetime
program[enrollment_open_to] If specified, enrollment is open only to this date-time Datetime
program[visibility] Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
program[enrollment_cap] A limit for the total number of enrollments Integer
program[enrollment_fee] Enrollment fee Decimal
program[allowed_payment_types] Allowed payment methods Array
program[days_to_complete] The number of days a student has to complete the requirements Integer
program[account_id] The id of the account to associate the listing to. Can be an id of any subcatalog of the catalog making the API request. Defaults to the catalog making the API request. Integer
program[list_order] Order in which the listing is shown in the catalog Integer
program[waitlist] Waitlist enabled (defaults to false) Boolean
program[waitlist_cap] Wait List Limit for the total number of wait listed enrollments Integer
program[listing_image] URL or file upload for the image to be shown with this listing. String
program[tag_names] List of tags applied to this listing Array
program[show_free_banner] Show the 'FREE' mark on the card of the listing if free Boolean
program[associated_account_ids] Other account ids where this product should be listed Array
sku Listing SKU String
program[requirement_ids] Ordered array of listing IDs that represent requirements for completing the program Array
program[sequential] Indicates if students are required to complete requirements in order Boolean

Request

Route

PUT https://www.my-catalog.edu/api/v1/programs/31

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "program": {
    "title": "Program 1",
    "description": "This is a very awesome program.",
    "path": "program-1",
    "teaser": "This is an example teaser",
    "enrollment_open": true,
    "visibility": "listed",
    "enrollment_cap": 150,
    "waitlist": true,
    "waitlist_cap": 12,
    "enrollment_fee": 49.99,
    "days_to_complete": 45,
    "list_order": 123,
    "requirement_ids": [

    ],
    "sequential": true,
    "sku": "abc1234",
    "tag_names": [
      "Tag",
      "Another Tag"
    ]
  }
}

Response

Status

204

Email domain set

Getting a specific email domain set

Endpoint

GET https://www.my-catalog.edu/api/v1/email_domain_sets/:id

Request

Route

GET https://www.my-catalog.edu/api/v1/email_domain_sets/1

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
email_domain_set[id] Email Domain Set ID Integer
email_domain_set[name] Certificate name String
email_domain_set[email_domains] An an array of email domains Array
email_domain_set[account_id] The account ID of the email domain set Integer
email_domain_set[created_at] The creation date of the email domain set Datetime
email_domain_set[updated_at] The last time the email domain set was updated Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": 1,
  "name": "Example",
  "account_id": 20,
  "canvas_root_account_uuid": "20WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
  "created_at": "2024/01/01 00:00:00 +0000",
  "updated_at": "2024/01/01 00:00:00 +0000",
  "deleted_at": null
}

List promotions by email domain set

Endpoint

GET https://www.my-catalog.edu/api/v1/email_domain_sets/:id/promotions

Request

Route

GET https://www.my-catalog.edu/api/v1/email_domain_sets/2/promotions

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
promotion[id] Promotion ID Integer
promotion[account_id] Account ID Integer
promotion[amount] The number representing the discount amount. Integer
promotion[discount_type] The type of discount. String
promotion[code] The code used to apply the discount. String
promotion[name] The name of the promotion. String
promotion[description] The description of the promotion. String
promotion[active] Whether the promotion is active. Boolean
promotion[start_date] When the promotion starts. Datetime
promotion[end_date] When the promotion ends. Datetime
promotion[created_at] When the promotion was created. Datetime
promotion[updated_at] When the promotion was updated. Datetime
promotion[deleted_at] When the promotion was deleted. Datetime
promotion[usage_type] What the promotions usage type is. String
promotion[canvas_root_account_uuid] The unique canvas account ID. String
promotion[email_domain_set_id] The Email Domain Set ID the promotion is restricted to. Integer

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "promotions": [
    {
      "id": 4,
      "account_id": 23,
      "product_id": null,
      "product_title": null,
      "product_archived_at": null,
      "account_name": "Domain Account 23",
      "currency": "USD",
      "amount": "10.0",
      "discount_type": "flat",
      "code": "PROMO4",
      "name": "Product 4",
      "description": null,
      "active": false,
      "start_date": null,
      "end_date": null,
      "created_at": "2024/01/01 00:00:00 +0000",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "deleted_at": null,
      "usage_type": "once-per-user",
      "canvas_root_account_uuid": "23WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
      "email_domain_set_id": 2,
      "email_domain_set_name": "Example",
      "email_domains": [
        {
          "id": 2,
          "domain": "example.com",
          "email_domain_set_id": 2,
          "canvas_root_account_uuid": "22WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
          "created_at": "2024/01/01 00:00:00 +0000",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "deleted_at": null
        }
      ],
      "status": "inactive",
      "max_per_user": null,
      "max_total_use": null
    }
  ]
}

Updating an email domain set

Endpoint

PUT https://www.my-catalog.edu/api/v1/email_domain_sets/:id

Parameters

Name Description Type
email_domain_set[name] The name of the Email Domain Set String
email_domain_set[email_domains_attributes] An array of email domains Array

Request

Route

PUT https://www.my-catalog.edu/api/v1/email_domain_sets/3

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "email_domain_set": {
    "name": "API Name",
    "email_domains_attributes": [
      {
        "domain": "example1.com"
      },
      {
        "domain": "example2.org"
      }
    ]
  }
}

Response

Response Fields

Name Description Type
email_domain_set[id] Email Domain Set ID Integer
email_domain_set[name] Certificate name String
email_domain_set[email_domains] An an array of email domains Array
email_domain_set[account_id] The account ID of the email domain set Integer
email_domain_set[created_at] The creation date of the email domain set Datetime
email_domain_set[updated_at] The last time the email domain set was updated Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "email_domain_set": {
    "id": 3,
    "name": "API Name",
    "account_id": 24,
    "email_domains": [
      {
        "id": 4,
        "domain": "example1.com",
        "email_domain_set_id": 3,
        "canvas_root_account_uuid": "24WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
        "created_at": "2024/01/01 00:00:00 +0000",
        "updated_at": "2024/01/01 00:00:00 +0000",
        "deleted_at": null
      },
      {
        "id": 5,
        "domain": "example2.org",
        "email_domain_set_id": 3,
        "canvas_root_account_uuid": "24WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
        "created_at": "2024/01/01 00:00:00 +0000",
        "updated_at": "2024/01/01 00:00:00 +0000",
        "deleted_at": null
      },
      {
        "id": 3,
        "domain": "example.com",
        "email_domain_set_id": 3,
        "canvas_root_account_uuid": "24WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
        "created_at": "2024/01/01 00:00:00 +0000",
        "updated_at": "2024/01/01 00:00:00 +0000",
        "deleted_at": null
      }
    ]
  }
}

Listing email domain sets

Endpoint

GET https://www.my-catalog.edu/api/v1/email_domain_sets

Parameters

Name Description Type
email_domain_set[search] A value to filter the Email Domain Sets by name String
email_domain_set[exact] A boolean to set whether the search should only include results that match exactly String

Request

Route

GET https://www.my-catalog.edu/api/v1/email_domain_sets

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "email_domain_sets": [
    {
      "id": 4,
      "name": "Example",
      "account_id": 26,
      "email_domains": [
        {
          "id": 6,
          "domain": "example.com",
          "email_domain_set_id": 4,
          "canvas_root_account_uuid": "26WLEJdzBmd8nsrZdf5jIATelBOYIMHeY6uuIAEmx",
          "created_at": "2024/01/01 00:00:00 +0000",
          "updated_at": "2024/01/01 00:00:00 +0000",
          "deleted_at": null
        }
      ]
    }
  ],
  "meta": {
    "total_pages": 0
  }
}

Courses

Some courses have failed to process successfully

Endpoint

PUT https://www.my-catalog.edu/api/v1/courses/archived

Parameters

Name Description Type
product_action required Action to perform. Possible values: archive, reactivate String
product_ids required Array of product ids to perform the action on Array

Request

Route

PUT https://www.my-catalog.edu/api/v1/courses/archived

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "product_action": "archive",
  "product_ids": [
    32,
    33,
    34,
    35
  ],
  "reason": "End of semester"
}

Response

Status

422

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "error": "Some products could not be archived",
  "details": {
    "product_ids": [
      35
    ]
  }
}

All courses have been successfully processed

Endpoint

PUT https://www.my-catalog.edu/api/v1/courses/archived

Parameters

Name Description Type
product_action required Action to perform. Possible values: archive, reactivate String
product_ids required Array of product ids to perform the action on Array

Request

Route

PUT https://www.my-catalog.edu/api/v1/courses/archived

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "product_action": "archive",
  "product_ids": [
    36,
    37
  ],
  "reason": "End of semester"
}

Response

Status

200

Headers

Content-Type: application/json

Creating a course

Endpoint

POST https://www.my-catalog.edu/api/v1/courses

Parameters

Name Description Type
course[title] required Listing title String
course[description] required Full listing description String
course[path] required Path to the listing. Used in URLs String
course[teaser] required A shorter description of the listing String
course[enrollment_open] Indicates if the listing is current accepting new students Boolean
course[enrollment_open_from] If specified, enrollment is open only from this date-time Datetime
course[enrollment_open_to] If specified, enrollment is open only to this date-time Datetime
course[visibility] Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
course[enrollment_cap] A limit for the total number of enrollments Integer
course[enrollment_fee] Enrollment fee Decimal
course[allowed_payment_types] Allowed payment methods Array
course[days_to_complete] The number of days a student has to complete the requirements Integer
course[account_id] The id of the account to associate the listing to. Can be an id of any subcatalog of the catalog making the API request. Defaults to the catalog making the API request. Integer
course[list_order] Order in which the listing is shown in the catalog Integer
course[waitlist] Waitlist enabled (defaults to false) Boolean
course[waitlist_cap] Wait List Limit for the total number of wait listed enrollments Integer
course[listing_image] URL or file upload for the image to be shown with this listing. String
course[tag_names] List of tags applied to this listing Array
course[show_free_banner] Show the 'FREE' mark on the card of the listing if free Boolean
course[associated_account_ids] Other account ids where this product should be listed Array
sku Listing SKU String
course[canvas_course_id] required Id of the related canvas course Integer
course[canvas_section_id] The Canvas course's section's id Integer
course[credits] Credit value of the course Decimal
course[instructor_names] Name of the course instructors Array
course[primary_instructor_name] Name of the primary instructor String

Request

Route

POST https://www.my-catalog.edu/api/v1/courses

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "course": {
    "title": "Course 1",
    "description": "This is a very important course.",
    "path": "course-1",
    "canvas_section_id": 20020020,
    "canvas_course_id": 10010010,
    "teaser": "This is an example teaser",
    "enrollment_open": true,
    "visibility": "listed",
    "enrollment_cap": 150,
    "waitlist": true,
    "waitlist_cap": 25,
    "enrollment_fee": 49.99,
    "days_to_complete": 45,
    "list_order": 123,
    "credits": 4,
    "sku": "abc1234",
    "tag_names": [
      "Tag",
      "Another Tag"
    ],
    "primary_instructor_name": "Jane Doe",
    "instructor_names": [
      "Jane Doe",
      "John Doe"
    ]
  }
}

Response

Response Fields

Name Description Type
id Identifier for this listing. Integer
visibility Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
enrollment_open Open for enrollment Boolean
enrollment_open_from If specified, enrollment is open only from this date-time Datetime
enrollment_open_to If specified, enrollment is open only to this date-time Datetime
enrollment_cap A limit for the total number of enrollments Integer
waitlist Waitlist enabled Boolean
waitlist_cap Wait List Limit for the total number of wait listed enrollments Integer
title Title of the listing String
enrollment_fee Enrollment fee Decimal
currency The three digit currency code associated to the enrollment fee String
listing_path Path to the listing. Used in URLs String
listing_url The URL of the listing String
short_description A short description for this listing String
list_order Order in which the listing is listed in the catalog Integer
tag_names List of tags applied to this listing Array
detail_code Payment detail code for a course (only if enabled with :payment_detail_code_enabled feature flag) String
show_free_banner Show the 'FREE' mark on the card of the listing if free Boolean
associated_account_ids Other account ids where this product should be listed Array
start_date When the Canvas course starts if specified Datetime
end_date When the Canvas course ends if specified Datetime
canvas_section_id The Canvas course's section's id Integer
catalog[id] Id for the catalog that owns this listing Integer
catalog[name] Name for the catalog that owns this listing String
created_at The creation date for the listing. Datetime
updated_at The last time the listing was updated. Datetime
sku Listing SKU String
archived_at Archival date (null if product is not archived) Datetime
canvas_course[id] Corresponding Canvas id Integer
credits Credit value of the course Decimal

Status

201

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "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.0,
    "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": 30,
      "name": "Domain Account 30"
    },
    "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"
  }
}

Listing courses

Endpoint

GET https://www.my-catalog.edu/api/v1/courses

Request

Route

GET https://www.my-catalog.edu/api/v1/courses

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "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.0,
      "created_at": "2024/01/01 00:00:00 +0000",
      "credits": 3.0,
      "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": 31,
        "name": "Domain Account 31"
      },
      "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"
    }
  ]
}

Updating course sku

Endpoint

PUT https://www.my-catalog.edu/api/v1/courses/update_skus

Parameters

Name Description Type
attachment required CSV containing a Catalog Course ID and Catalog Course SKU header file

Request

Route

PUT https://www.my-catalog.edu/api/v1/courses/update_skus

Headers

Authorization: Token token="my-token"
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Host: www.my-catalog.edu

Body

------------XnJLe9ZIbbGUYtzPQJ16u1
content-disposition: form-data; name="attachment"; filename="missing_header1.csv"
content-type: text/plain
content-length: 69

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "progress": {
    "id": 1,
    "account_id": 32,
    "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"
  }
}

Updating a course

Endpoint

PUT https://www.my-catalog.edu/api/v1/courses/:id

Parameters

Name Description Type
course[title] Listing title String
course[description] Full listing description String
course[path] Path to the listing. Used in URLs String
course[teaser] A shorter description of the listing String
course[enrollment_open] Indicates if the listing is current accepting new students Boolean
course[enrollment_open_from] If specified, enrollment is open only from this date-time Datetime
course[enrollment_open_to] If specified, enrollment is open only to this date-time Datetime
course[visibility] Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
course[enrollment_cap] A limit for the total number of enrollments Integer
course[enrollment_fee] Enrollment fee Decimal
course[allowed_payment_types] Allowed payment methods Array
course[days_to_complete] The number of days a student has to complete the requirements Integer
course[account_id] The id of the account to associate the listing to. Can be an id of any subcatalog of the catalog making the API request. Defaults to the catalog making the API request. Integer
course[list_order] Order in which the listing is shown in the catalog Integer
course[waitlist] Waitlist enabled (defaults to false) Boolean
course[waitlist_cap] Wait List Limit for the total number of wait listed enrollments Integer
course[listing_image] URL or file upload for the image to be shown with this listing. String
course[tag_names] List of tags applied to this listing Array
course[show_free_banner] Show the 'FREE' mark on the card of the listing if free Boolean
course[associated_account_ids] Other account ids where this product should be listed Array
sku Listing SKU String
course[canvas_course_id] Id of the related canvas course Integer
course[canvas_section_id] The Canvas course's section's id Integer
course[credits] Credit value of the course Decimal
course[instructor_names] Name of the course instructors Array
course[primary_instructor_name] Name of the primary instructor String

Request

Route

PUT https://www.my-catalog.edu/api/v1/courses/40

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "course": {
    "title": "Course 1",
    "description": "This is a very important course.",
    "path": "course-1",
    "canvas_section_id": 20020020,
    "canvas_course_id": 10010010,
    "teaser": "This is an example teaser",
    "enrollment_open": true,
    "visibility": "listed",
    "enrollment_cap": 150,
    "waitlist": true,
    "waitlist_cap": 25,
    "enrollment_fee": 49.99,
    "days_to_complete": 45,
    "list_order": 123,
    "credits": 4,
    "sku": "abc1234",
    "tag_names": [
      "Tag",
      "Another Tag"
    ],
    "primary_instructor_name": "Jane Doe",
    "instructor_names": [
      "Jane Doe",
      "John Doe"
    ]
  }
}

Response

Status

204

Getting a specific course

Endpoint

GET https://www.my-catalog.edu/api/v1/courses/:id

Request

Route

GET https://www.my-catalog.edu/api/v1/courses/41

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Identifier for this listing. Integer
visibility Indicates if the listing is visible in the web UI. Possible values: listed, unlisted, hidden String
enrollment_open Open for enrollment Boolean
enrollment_open_from If specified, enrollment is open only from this date-time Datetime
enrollment_open_to If specified, enrollment is open only to this date-time Datetime
enrollment_cap A limit for the total number of enrollments Integer
waitlist Waitlist enabled Boolean
waitlist_cap Wait List Limit for the total number of wait listed enrollments Integer
title Title of the listing String
enrollment_fee Enrollment fee Decimal
currency The three digit currency code associated to the enrollment fee String
listing_path Path to the listing. Used in URLs String
listing_url The URL of the listing String
short_description A short description for this listing String
list_order Order in which the listing is listed in the catalog Integer
tag_names List of tags applied to this listing Array
detail_code Payment detail code for a course (only if enabled with :payment_detail_code_enabled feature flag) String
show_free_banner Show the 'FREE' mark on the card of the listing if free Boolean
associated_account_ids Other account ids where this product should be listed Array
start_date When the Canvas course starts if specified Datetime
end_date When the Canvas course ends if specified Datetime
canvas_section_id The Canvas course's section's id Integer
catalog[id] Id for the catalog that owns this listing Integer
catalog[name] Name for the catalog that owns this listing String
created_at The creation date for the listing. Datetime
updated_at The last time the listing was updated. Datetime
sku Listing SKU String
archived_at Archival date (null if product is not archived) Datetime
canvas_course[id] Corresponding Canvas id Integer
credits Credit value of the course Decimal

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "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.0,
    "created_at": "2024/01/01 00:00:00 +0000",
    "credits": 3.0,
    "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": 34,
      "name": "Domain Account 35"
    },
    "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"
  }
}

Deleting a specific course

Endpoint

DELETE https://www.my-catalog.edu/api/v1/courses/:id

Request

Route

DELETE https://www.my-catalog.edu/api/v1/courses/42

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu
Content-Type: application/x-www-form-urlencoded

Response

Status

204

Analytics

The POST request parameters should be sent as JSON in the request body.
If the request is unfiltered, an empty JSON object should be sent as the filter.

Getting products analytics

Endpoint

POST https://www.my-catalog.edu/api/v1/analytics/products

Parameters

Name Description Type Items
account_ids List of account ids array {"type"=>"integer"}
product_ids List of product ids array {"type"=>"integer"}
product_statuses List of product statuses (OPEN, CLOSED, and/or DELETED) array {"type"=>"string"}
creation_date_from Creation date from string
creation_date_to Creation date to string
enrollment_count_min Enrollment count minimum integer
enrollment_count_max Enrollment count maximum integer
completion_count_min Completion count minimum integer
completion_count_max Completion count maximum integer
dropped_count_min Dropped count minimum integer
dropped_count_max Dropped count maximum integer
listing_price_min Listing price minimum number
listing_price_max Listing price maximum number
promo_codes List of promotion code states (APPLIED and/or NOT_APPLIED) array {"type"=>"string"}
revenue_min Revenue minimum number
revenue_max Revenue maximum number
certificate_offered Certificate offered for the product boolean

Request

Route

POST https://www.my-catalog.edu/api/v1/analytics/products

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "account_ids": [
    1,
    2,
    3
  ],
  "product_ids": [
    1,
    2,
    3
  ],
  "product_statuses": [
    "OPEN",
    "CLOSED",
    "ARCHIVED",
    "DELETED"
  ],
  "creation_date_from": "2023-06-05T14:46:59.944581+02:00",
  "creation_date_to": "2023-06-06T14:46:59.944581+02:00",
  "enrollment_count_min": 0,
  "enrollment_count_max": 5,
  "completion_count_min": 0,
  "completion_count_max": 5,
  "dropped_count_min": 0,
  "dropped_count_max": 5,
  "listing_price_min": 10.1,
  "listing_price_max": 1000.5,
  "promo_codes": [
    "APPLIED",
    "NOT_APPLIED"
  ],
  "revenue_min": 10.1,
  "revenue_max": 500.5,
  "certificate_offered": true
}

Response

Response Fields

Name Description type items
account_id Account id integer
account_name Account name string
product[name] Product name string
product[id] Product id integer
product[url] Product url (null if product is deleted) string
product[sku] Product sku string
product_status Product status (OPEN, CLOSED, or DELETED) string
created_at Product creation date string
canvas_course_id Canvas course id integer
enrollment_count Enrollment count integer
dropped_count Dropped count integer
completion_count Completion count integer
currency Currency string
list_price Listing price number
promo_codes List of promotion codes array {"type"=>"string"}
discount Discount number
revenue Revenue number
points Points (null if account measurement is not point) number
ceus CEUs (null if account measurement is not CEU) number
credits Credits (null if account measurement is not credit) number
certificate_offered Certificate offered for this product boolean
primary_instructor_name Name of the primary instructor string
instructor_names Name of the course instructors array {"type"=>"string"}
archived_at Archival date (null if product is not archived) string

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "products": [
    {
      "account_id": 3,
      "account_name": "Sub-Account 1",
      "product": {
        "name": "Course 1",
        "id": 5,
        "url": "https://www.my-catalog.edu/listings/1/edit",
        "sku": "sku"
      },
      "product_status": "OPEN",
      "created_at": "2023-06-05T14:46:59.944581+02:00",
      "canvas_course_id": 11,
      "enrollment_count": 7,
      "dropped_count": 3,
      "completion_count": 2,
      "currency": "USD",
      "list_price": 10.0,
      "promo_codes": [
        "PROMO1",
        "PROMO2"
      ],
      "discount": 10.0,
      "revenue": 60.0,
      "credits": 5.0,
      "certificate_offered": true,
      "instructor_names": [
        "Instructor 1",
        "Instructor 2"
      ],
      "primary_instructor_name": "Instructor 1",
      "archived_at": "2024-08-01T14:46:59.944581+02:00"
    }
  ]
}

Getting enrollments analytics

Endpoint

POST https://www.my-catalog.edu/api/v1/analytics/enrollments

Parameters

Name Description Type Items
account_ids List of account ids array {"type"=>"integer"}
product_ids List of product ids array {"type"=>"integer"}
product_statuses List of product statuses (OPEN, CLOSED, and/or DELETED) array {"type"=>"string"}
student_ids List of student ids(catalog user id) array {"type"=>"integer"}
student_canvas_user_ids List of student ids(canvas user id) array {"type"=>"integer"}
enrollment_date_from Enrollment date from string
enrollment_date_to Enrollment date to string
enrollment_statuses List of enrollment statuses (ACTIVE, COMPLETED, DROPPED and/or CONCLUDED) array {"type"=>"string"}
completion_date_from Completion date from string
completion_date_to Completion date to string

Request

Route

POST https://www.my-catalog.edu/api/v1/analytics/enrollments

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "account_ids": [
    1,
    2,
    3
  ],
  "product_ids": [
    1,
    2,
    3
  ],
  "product_statuses": [
    "OPEN",
    "CLOSED",
    "ARCHIVED",
    "DELETED"
  ],
  "student_ids": [
    1,
    2,
    3
  ],
  "student_canvas_user_ids": [
    1,
    2,
    3
  ],
  "enrollment_date_from": "2023-06-05T14:46:59.944581+02:00",
  "enrollment_date_to": "2023-06-06T14:46:59.944581+02:00",
  "enrollment_statuses": [
    "ACTIVE",
    "COMPLETED",
    "DROPPED",
    "CONCLUDED"
  ],
  "completion_date_from": "2023-06-05T14:46:59.944581+02:00",
  "completion_date_to": "2023-06-06T14:46:59.944581+02:00"
}

Response

Response Fields

Name Description type items
id Enrollment id integer
account_id Account id integer
account_name Account name string
product[name] Product name string
product[id] Product id integer
product[url] Product url (null if product is deleted) string
product[sku] Product sku string
product_status Product status (OPEN, CLOSED, or DELETED) string
canvas_course_id Canvas course id integer
student[canvas_user_id] Student Canvas user id integer
student[name] Student name string
student[email] Student email string
student[canvas_user_id_string] Canvas user id in string format string
requirement_count The total number of requirements for the enrollment integer
requirement_completed_count The number of completed requirements integer
requirement_completed_percentage The percentage of completed requirements (0,100) integer
created_at Creation date string
completed_at Completion date string
enrollment_status Enrollment status (ACTIVE, COMPLETED, DROPPED or CONCLUDED) string
certificate_attainable Product has a certificate boolean
certificate_offered Certificate offered/earned boolean
custom_fields List of custom fields (consist of key and value) array {"type"=>"object"}
certificate_url Certificate url string
product_archived_at Product archival date (null if product is not archived) string

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "enrollments": [
    {
      "id": 25,
      "account_id": 3,
      "account_name": "Sub-Account 1",
      "product": {
        "name": "Course 1",
        "id": 5,
        "url": "https://www.my-catalog.edu/listings/1/edit",
        "sku": "sku"
      },
      "product_status": "OPEN",
      "canvas_course_id": 11,
      "student": {
        "canvas_user_id": 1,
        "name": "User 15",
        "email": "user15@instructure.com",
        "canvas_user_id_string": "1"
      },
      "requirement_count": 4,
      "requirement_completed_count": 2,
      "requirement_completed_percentage": 2,
      "created_at": "2023-06-05T14:46:59.944581+02:00",
      "completed_at": "2023-06-29T12:13:27+02:00",
      "enrollment_status": "COMPLETED",
      "certificate_attainable": true,
      "certificate_offered": true,
      "custom_fields": [
        {
          "key": "text_udf",
          "value": "awesome udf"
        },
        {
          "key": "checkbox_udf",
          "value": "1"
        }
      ],
      "certificate_url": "https://www.my-catalog.edu/admin/certificates/1.pdf?user_id=1",
      "archived_at": "2024-08-01T14:46:59.944581+02:00"
    }
  ]
}

Getting orders analytics

Endpoint

POST https://www.my-catalog.edu/api/v1/analytics/orders

Parameters

Name Description Type Items
account_ids List of account ids array {"type"=>"integer"}
product_ids List of product ids array {"type"=>"integer"}
product_statuses List of product statuses (OPEN, CLOSED, and/or DELETED) array {"type"=>"string"}
student_ids List of student ids(catalog user id) array {"type"=>"integer"}
student_canvas_user_ids List of student ids(canvas user id) array {"type"=>"integer"}
purchaser_ids List of purchaser ids(catalog user id) array {"type"=>"integer"}
purchaser_canvas_user_ids List of purchaser ids(canvas user id) array {"type"=>"integer"}
bulk_purchases_only Bulk purchases only boolean
purchase_date_from Purchase date from string
purchase_date_to Purchase date to string
order_fee List of order fee types (FREE and/or PAID) array {"type"=>"string"}
listing_price_min Listing price minimum number
listing_price_max Listing price maximum number
promo_codes List of promotion code states (APPLIED and/or NOT_APPLIED) array {"type"=>"string"}
revenue_min Revenue minimum number
revenue_max Revenue maximum number

Request

Route

POST https://www.my-catalog.edu/api/v1/analytics/orders

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "account_ids": [
    1,
    2,
    3
  ],
  "product_ids": [
    1,
    2,
    3
  ],
  "product_statuses": [
    "OPEN",
    "CLOSED",
    "ARCHIVED",
    "DELETED"
  ],
  "student_ids": [
    1,
    2,
    3
  ],
  "student_canvas_user_ids": [
    1,
    2,
    3
  ],
  "purchaser_ids": [
    1,
    2,
    3
  ],
  "purchaser_canvas_user_ids": [
    1,
    2,
    3
  ],
  "bulk_purchases_only": true,
  "purchase_date_from": "2023-06-05T14:46:59.944581+02:00",
  "purchase_date_to": "2023-06-06T14:46:59.944581+02:00",
  "order_fee": 10.0,
  "listing_price_min": 5.0,
  "listing_price_max": 100.6,
  "promo_codes": [
    "APPLIED",
    "NOT_APPLIED"
  ],
  "revenue_min": 5.0,
  "revenue_max": 1000.1
}

Response

Response Fields

Name Description type items
account_id Account id integer
account_name Account name string
product[name] Product name string
product[id] Product id integer
product[url] Product url (null if product is deleted) string
product[sku] Product sku string
product_status Product status (OPEN, CLOSED, or DELETED) string
canvas_course_id Canvas course id integer
purchaser[id] Purchaser Catalog user id integer
purchaser[canvas_user_id] Purchaser Canvas user id integer
purchaser[name] Purchaser name string
purchaser[email] Purchaser email string
purchaser[canvas_user_id_string] Purchaser Canvas user id in string format string
purchased_at Purchase date string
order_id Order id integer
order_item_id Order item id integer
reference_id Reference id string
list_price Listing price number
currency Currency string
promo_codes List of promotion codes array {"type"=>"string"}
discount Discount number
revenue Revenue number
bulk_purchase Bulk purchase boolean
seat_count Seat count integer
bulk_enrollments List of bulk enrolled students array {"type"=>"object"}
bulk_enrollments[id] Bulk enrolled Catalog user id integer
bulk_enrollments[canvas_user_id] Bulk enrolled Canvas user id integer
bulk_enrollments[name] Bulk enrolled student name string
bulk_enrollments[email] Bulk enrolled student email string
bulk_enrollments[canvas_user_id_string] Bulk enrolled Canvas user id in string format string
last_modification_date Last modification date of revenue string
revenue_change_history Revenue change history list array {"type"=>"object"}
revenue_change_history[modification_date] Modification date of revenue update string
revenue_change_history[new_value] New revenue value number
revenue_change_history[new_value_currency] New revenue value currency string
revenue_change_history[old_value] Old revenue value number
revenue_change_history[old_value_currency] Old revenue value currency string
revenue_change_history[reason] Reason of revenue update string
revenue_change_history[user_name] Name of the user who updated the revenue string
revenue_change_history[user_profile_link] Link to the user profile string

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "orders": [
    {
      "account_id": 3,
      "account_name": "Sub-Account 1",
      "product": {
        "name": "Course 1",
        "id": 5,
        "url": "https://www.my-catalog.edu/listings/1/edit",
        "sku": "sku"
      },
      "product_status": "OPEN",
      "canvas_course_id": 11,
      "purchaser": {
        "id": 1,
        "canvas_user_id": 1,
        "name": "Purchaser 1",
        "email": "purchaser1@instructure.com",
        "canvas_user_id_string": "1"
      },
      "purchased_at": "2023-07-02T23:30:59.052239+02:00",
      "order_id": 81,
      "order_item_id": 123,
      "reference_id": "PR-81-82",
      "list_price": 5.0,
      "currency": "USD",
      "promo_codes": [
        "PROMO1",
        "PROMO2"
      ],
      "discount": 10.0,
      "revenue": 5.0,
      "bulk_purchase": true,
      "seat_count": 3,
      "bulk_enrollments": [
        {
          "id": 141,
          "canvas_user_id": 74,
          "name": "User 17",
          "email": "user17@instructure.com",
          "canvas_user_id_string": "74"
        },
        {
          "id": 138,
          "canvas_user_id": 73,
          "name": "User 16",
          "email": "user16@instructure.com",
          "canvas_user_id_string": "73"
        }
      ],
      "last_modification_date": "2023-07-09T23:30:59.052239+02:00",
      "revenue_change_history": [
        {
          "modification_date": "2023-07-09T23:30:59.052239+02:00",
          "new_value": 5.0,
          "new_value_currency": "USD",
          "old_value": 2.0,
          "old_value_currency": "USD",
          "reason": "This is very important",
          "user_name": "user19@instructure.com",
          "user_profile_link": "https://www.my-catalog.edu/accounts/2/users/1"
        },
        {
          "modification_date": "2023-07-08T23:30:59.052239+02:00",
          "new_value": 2.0,
          "new_value_currency": "USD",
          "old_value": 11.0,
          "old_value_currency": "USD",
          "reason": "This is important",
          "user_name": "user20@instructure.com",
          "user_profile_link": "https://www.my-catalog.edu/accounts/2/users/2"
        }
      ]
    }
  ]
}

Getting users analytics

Endpoint

POST https://www.my-catalog.edu/api/v1/analytics/users

Parameters

Name Description Type Items
account_ids List of account ids array {"type"=>"integer"}
student_ids List of student ids(catalog user id) array {"type"=>"integer"}
student_canvas_user_ids List of student ids(canvas user id) array {"type"=>"integer"}
enrollment_count_min Enrollment count minimum integer
enrollment_count_max Enrollment count maximum integer
last_enrollment_date_from Last enrollment date from string
last_enrollment_date_to Last enrollment date to string
registration_date_from Registration date from string
registration_date_to Registration date to string
registered_through List of registration sources (CANVAS and/or CATALOG) array {"type"=>"string"}

Request

Route

POST https://www.my-catalog.edu/api/v1/analytics/users

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "account_ids": [
    1,
    2,
    3
  ],
  "student_ids": [
    1,
    2,
    3
  ],
  "student_canvas_user_ids": [
    1,
    2,
    3
  ],
  "enrollment_count_min": 0,
  "enrollment_count_max": 5,
  "last_enrollment_date_from": "2023-06-05T14:46:59.944581+02:00",
  "last_enrollment_date_to": "2023-06-06T14:46:59.944581+02:00",
  "registration_date_from": "2023-06-05T14:46:59.944581+02:00",
  "registration_date_to": "2023-06-06T14:46:59.944581+02:00",
  "registered_through": [
    "CANVAS",
    "CATALOG"
  ]
}

Response

Response Fields

Name Description type items
id Catalog user id integer
canvas_user_id Canvas user id integer
name User name string
email User email string
account_id Account id integer
account_name Account name string
registered_through Registration source (CANVAS or CATALOG) string
registered_at Registration date string
enrollment_count Enrollment count integer
last_enrolled_at Last Enrollment date string
custom_fields List of custom fields (consist of key and value) array {"type"=>"object"}

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "users": [
    {
      "id": 150,
      "canvas_user_id": 77,
      "name": "User 19",
      "email": "user19@instructure.com",
      "account_id": 3,
      "account_name": "Sub-Account 1",
      "registered_through": "CATALOG",
      "registered_at": "2023-07-03T15:03:57.597+02:00",
      "enrollment_count": 2,
      "last_enrolled_at": "2023-07-06T17:30:50.991764+02:00",
      "custom_fields": [
        {
          "key": "text_udf",
          "value": "awesome udf"
        },
        {
          "key": "checkbox_udf",
          "value": "1"
        }
      ]
    }
  ]
}

Catalogs

Getting a specific catalog

Endpoint

GET https://www.my-catalog.edu/api/v1/catalogs/:id

Request

Route

GET https://www.my-catalog.edu/api/v1/catalogs/40

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Identifier for this catalog. Integer
created_at The creation date for the catalog. Datetime
updated_at The last time the catalog was updated. Datetime
name The name of the catalog. String
canvas_domain Domain for the corresponding canvas account. String
canvas_id Id for the corresponding canvas account. String
logo URL for the catalog logo. String
locale Three character locale for the catalog. String
url Url for the catalog String
user_defined_fields An array of serialized user defined field records provided to the catalog either through direct assignment or inheritance. Array
user_defined_field[name] Name of the user defined field String
user_defined_field[label] Label that will be shown with the field String
user_defined_field[field_type] HTML input type of the field String
user_defined_field[required] Indicates if the custom field is required Boolean
user_defined_field[hide_in_user_workflow] Indicates whether the custom field should be hidden in user workflow or not. Boolean
parent[id] The id of the parent catalog Integer
parent[name] The name of the parent catalog Integer
settings[privacy_policy_url] Url of the privacy policy for this catalog. String
settings[terms_url] Url of the terms used for this catalog. String
settings[currency] Three character currency code. String
settings[time_zone] Timezone configured for this catalog. String
settings[country] Two character country code. String
settings[email_from_name] Name that appears as the sender in emails. String
settings[allow_user_registration] Indicates if new users allowed to enroll classes. Boolean
settings[title_tag] Used for custom titles in HTML. String
settings[meta_description] Used to a meta tag description in HTML. String
settings[custom_head_content] Used to add custom head content to HTML. String
settings[custom_body_content] Used to add custom body content to HTML. String
settings[show_listings_in_parent] Indicates if this catalogs listings will show in a parent catalog. Boolean
settings[skus_enabled] Indicates if the course displays the sku field. Boolean

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "account": {
    "id": 40,
    "name": "Domain Account 41",
    "parent": null,
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "canvas_domain": "www.canvas-domain-41.com",
    "canvas_id": 41,
    "settings": {
      "privacy_policy_url": "https://www.instructure.com/policies/privacy/",
      "terms_url": "https://www.instructure.com/policies/acceptable-use",
      "currency": "USD",
      "supported_payment_types": "standard",
      "time_zone": null,
      "country": "US",
      "measurement": "credit",
      "email_from_name": "Canvas Catalog",
      "email_from_address": "notifications@instructure.com",
      "allow_user_registration": true,
      "title_tag": null,
      "meta_description": null,
      "custom_head_content": null,
      "custom_body_content": null,
      "show_listings_in_parent": true,
      "order_id_prefix": null,
      "inherit_categories": false,
      "inherit_user_defined_fields": false,
      "beta_canvas_domain": null,
      "skus_enabled": false,
      "canvas_enrollment_events": false,
      "include_noncatalog_courses_in_dashboard": true,
      "external_idp_logout_workflow": false,
      "private_catalog": false,
      "bulk_purchase_disabled": false,
      "enroll_button_behavior": "cart",
      "shopping_cart_enabled": true,
      "external_registration_url": null,
      "external_registration_public_key": null,
      "redirect_external_registration_condition": "authenticated",
      "include_captcha": false,
      "user_registration_domain_restriction_type": "inherit",
      "user_registration_domain_deny_list": "",
      "user_registration_domain_allow_list": "",
      "restrict_enrollment_to_user_registration_domain": false,
      "frame_ancestors": "",
      "email_reply_to": "",
      "has_sso_warning": false,
      "measurement_id": null,
      "redirect_non_admins_to_root_url": false,
      "canvas_feature_send_usage_metrics": false,
      "disable_passive_login": false,
      "new_storefront": false,
      "tags_permission_default_value": true,
      "cross_listing_permission_default_value": false,
      "inherit_storefront_theme": false,
      "canvas_authentication_provider_id": "CANVAS_FIRST",
      "udf_collection_level": "registration",
      "disable_drop_course_button": false,
      "google_tag_manager_id": null,
      "linkedin_partner_id": null,
      "enable_credentials": false,
      "enable_impact": false,
      "enable_pathways": false,
      "hide_missing_pathway": false,
      "storefront_product_recommendation_behavior": "popular",
      "storefront_product_recommendation_count": 4,
      "enable_recommendations": false,
      "product_page_recommendation_fallback": "no_fallback",
      "product_page_recommendation_count": 4,
      "enable_recommendations_for_product_page": false,
      "hide_self_paced_label": false,
      "login_auth_providers": "[]",
      "multiple_promo_codes_enabled": true,
      "custom_instructor_label": null,
      "custom_instructor_label_plural": null
    },
    "user_defined_fields": [
      {
        "list_order": 0,
        "name": "favorite_color",
        "label": "Favorite Color",
        "field_type": "text",
        "required": false,
        "required_message": "Favorite Color is required",
        "metadata": {
        },
        "hide_in_user_workflow": true
      },
      {
        "list_order": 1,
        "name": "code_of_conduct",
        "label": "Code of Conduct",
        "field_type": "checkbox",
        "required": true,
        "required_message": "You must accept the Code of Conduct.",
        "metadata": {
        },
        "hide_in_user_workflow": false
      },
      {
        "list_order": 2,
        "name": "age",
        "label": "Age",
        "field_type": "text",
        "required": true,
        "required_message": "You must provide an Age.",
        "metadata": {
        },
        "hide_in_user_workflow": false
      },
      {
        "list_order": 3,
        "name": "yes_no",
        "label": "Yes or No",
        "field_type": "select",
        "required": false,
        "required_message": "Yes or No is required",
        "metadata": {
          "options": [
            "Yes",
            "No"
          ]
        },
        "hide_in_user_workflow": false
      }
    ],
    "logo": "https://test-bucket.s3.amazonaws.com/production/logos/10dee78ef4ea7d5266cee307f035811daf828d9b.jpeg",
    "locale": "en",
    "url": "https://www.my-catalog.edu",
    "measurement": "credit",
    "storefront_theme_id": null
  }
}

Listing catalogs

Endpoint

GET https://www.my-catalog.edu/api/v1/catalogs

Request

Route

GET https://www.my-catalog.edu/api/v1/catalogs

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Identifier for this catalog. Integer
created_at The creation date for the catalog. Datetime
updated_at The last time the catalog was updated. Datetime
name The name of the catalog. String
canvas_domain Domain for the corresponding canvas account. String
canvas_id Id for the corresponding canvas account. String
logo URL for the catalog logo. String
locale Three character locale for the catalog. String
url Url for the catalog String
user_defined_fields An array of serialized user defined field records provided to the catalog either through direct assignment or inheritance. Array
user_defined_field[name] Name of the user defined field String
user_defined_field[label] Label that will be shown with the field String
user_defined_field[field_type] HTML input type of the field String
user_defined_field[required] Indicates if the custom field is required Boolean
user_defined_field[hide_in_user_workflow] Indicates whether the custom field should be hidden in user workflow or not. Boolean
parent[id] The id of the parent catalog Integer
parent[name] The name of the parent catalog Integer
settings[privacy_policy_url] Url of the privacy policy for this catalog. String
settings[terms_url] Url of the terms used for this catalog. String
settings[currency] Three character currency code. String
settings[time_zone] Timezone configured for this catalog. String
settings[country] Two character country code. String
settings[email_from_name] Name that appears as the sender in emails. String
settings[allow_user_registration] Indicates if new users allowed to enroll classes. Boolean
settings[title_tag] Used for custom titles in HTML. String
settings[meta_description] Used to a meta tag description in HTML. String
settings[custom_head_content] Used to add custom head content to HTML. String
settings[custom_body_content] Used to add custom body content to HTML. String
settings[show_listings_in_parent] Indicates if this catalogs listings will show in a parent catalog. Boolean
settings[skus_enabled] Indicates if the course displays the sku field. Boolean

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "catalogs": [
    {
      "id": 41,
      "name": "Domain Account 46",
      "parent": null,
      "created_at": "2024/01/01 00:00:00 +0000",
      "updated_at": "2024/01/01 00:00:00 +0000",
      "canvas_domain": "www.canvas-domain-46.com",
      "canvas_id": 46,
      "settings": {
        "privacy_policy_url": "https://www.instructure.com/policies/privacy/",
        "terms_url": "https://www.instructure.com/policies/acceptable-use",
        "currency": "USD",
        "supported_payment_types": "standard",
        "time_zone": null,
        "country": "US",
        "measurement": "credit",
        "email_from_name": "Canvas Catalog",
        "email_from_address": "notifications@instructure.com",
        "allow_user_registration": true,
        "title_tag": null,
        "meta_description": null,
        "custom_head_content": null,
        "custom_body_content": null,
        "show_listings_in_parent": true,
        "order_id_prefix": null,
        "inherit_categories": false,
        "inherit_user_defined_fields": false,
        "beta_canvas_domain": null,
        "skus_enabled": false,
        "canvas_enrollment_events": false,
        "include_noncatalog_courses_in_dashboard": true,
        "external_idp_logout_workflow": false,
        "private_catalog": false,
        "bulk_purchase_disabled": false,
        "enroll_button_behavior": "cart",
        "shopping_cart_enabled": true,
        "external_registration_url": null,
        "external_registration_public_key": null,
        "redirect_external_registration_condition": "authenticated",
        "include_captcha": false,
        "user_registration_domain_restriction_type": "inherit",
        "user_registration_domain_deny_list": "",
        "user_registration_domain_allow_list": "",
        "restrict_enrollment_to_user_registration_domain": false,
        "frame_ancestors": "",
        "email_reply_to": "",
        "has_sso_warning": false,
        "measurement_id": null,
        "redirect_non_admins_to_root_url": false,
        "canvas_feature_send_usage_metrics": false,
        "disable_passive_login": false,
        "new_storefront": false,
        "tags_permission_default_value": true,
        "cross_listing_permission_default_value": false,
        "inherit_storefront_theme": false,
        "canvas_authentication_provider_id": "CANVAS_FIRST",
        "udf_collection_level": "registration",
        "disable_drop_course_button": false,
        "google_tag_manager_id": null,
        "linkedin_partner_id": null,
        "enable_credentials": false,
        "enable_impact": false,
        "enable_pathways": false,
        "hide_missing_pathway": false,
        "storefront_product_recommendation_behavior": "popular",
        "storefront_product_recommendation_count": 4,
        "enable_recommendations": false,
        "product_page_recommendation_fallback": "no_fallback",
        "product_page_recommendation_count": 4,
        "enable_recommendations_for_product_page": false,
        "hide_self_paced_label": false,
        "login_auth_providers": "[]",
        "multiple_promo_codes_enabled": true,
        "custom_instructor_label": null,
        "custom_instructor_label_plural": null
      },
      "user_defined_fields": [
        {
          "list_order": 0,
          "name": "favorite_color",
          "label": "Favorite Color",
          "field_type": "text",
          "required": false,
          "required_message": "Favorite Color is required",
          "metadata": {
          },
          "hide_in_user_workflow": true
        },
        {
          "list_order": 1,
          "name": "code_of_conduct",
          "label": "Code of Conduct",
          "field_type": "checkbox",
          "required": true,
          "required_message": "You must accept the Code of Conduct.",
          "metadata": {
          },
          "hide_in_user_workflow": false
        },
        {
          "list_order": 2,
          "name": "age",
          "label": "Age",
          "field_type": "text",
          "required": true,
          "required_message": "You must provide an Age.",
          "metadata": {
          },
          "hide_in_user_workflow": false
        },
        {
          "list_order": 3,
          "name": "yes_no",
          "label": "Yes or No",
          "field_type": "select",
          "required": false,
          "required_message": "Yes or No is required",
          "metadata": {
            "options": [
              "Yes",
              "No"
            ]
          },
          "hide_in_user_workflow": false
        }
      ],
      "logo": "https://test-bucket.s3.amazonaws.com/production/logos/06ef4a23e0e000ace0bf8bbe66614b02272038fd.jpeg",
      "locale": "en",
      "url": "https://www.my-catalog.edu",
      "measurement": "credit",
      "storefront_theme_id": null
    }
  ]
}

Completed certificates

Listing user's completions with a certificate

Endpoint

GET https://www.my-catalog.edu/api/v1/completed_certificates

Parameters

Name Description Type
user_id required Canvas Id of the user Integer
only_certificates Indicates if the courses without certificates should be included, default is to include all courses Boolean

Request

Route

GET https://www.my-catalog.edu/api/v1/completed_certificates?user_id=1&only_certificates=true

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Query Parameters

user_id=1
only_certificates=true

Response

Response Fields

Name Description Type
canvas_course_id Canvas Course ID Integer
catalog_title catalog course title String
canvas_course_name Canvas Course name String
certificate_url URL for Course Certificate String
canvas_course_workflow_state Canvas Course Workflow State String
completed_at Canvas Course Completion Date Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "completed_certificates": [
    {
      "canvas_course_id": 25,
      "catalog_title": "Course 41",
      "canvas_course_name": "Course 41",
      "certificate_url": "https://www.domain-51.com/certificates/certificate-numero-1-1.pdf",
      "canvas_course_workflow_state": "available",
      "completed_at": null
    }
  ]
}

Enrollments

Listing enrollments

Endpoint

GET https://www.my-catalog.edu/api/v1/enrollments

Parameters

Name Description Type
listing_id Only include enrollments for the specified listing Integer

Request

Route

GET https://www.my-catalog.edu/api/v1/enrollments

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "enrollments": [
    {
      "id": 2,
      "user": {
        "id": 1
      },
      "listing": {
        "id": 44,
        "title": "Course 42",
        "type": "Course",
        "canvas_course_id": 26
      },
      "enrolled_at": "2024/01/01 00:00:00 +0000",
      "status": "active",
      "requirement_details": {
        "requirement_count": null,
        "requirement_completed_count": null,
        "requirement_completed_percentage": null
      }
    }
  ]
}

Deleting an enrollment

An additional request must be made to Canvas to delete the enrollment and remove it from the Catalog Student Dashboard

Endpoint

DELETE https://www.my-catalog.edu/api/v1/enrollments/:id

Request

Route

DELETE https://www.my-catalog.edu/api/v1/enrollments/3

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu
Content-Type: application/x-www-form-urlencoded

Response

Response Fields

Name Description Type
id Identifier for this enrollment Integer
user[id] Corresponding Canvas user id for this enrollment. Integer
listing[id] Identifier for the listing Integer
listing[title] The name of the listing String
listing[type] The type of listing (Course or Program) String
listing[canvas_course_id] Canvas course ID (nil for Program enrollments) String
enrolled_at The time of enrollment (UTC) Datetime
status Enrollment status (active, dropped or concluded) String
requirement_details[requirement_count] The total number of requirements for the enrollment Integer
requirement_details[requirement_completed_count] The number of completed requirements Integer
requirement_details[requirement_completed_percentage] The percentage of completed requirements (0,100) Integer

Status

204

Getting a specific enrollment

Endpoint

GET https://www.my-catalog.edu/api/v1/enrollments/:id

Request

Route

GET https://www.my-catalog.edu/api/v1/enrollments/4

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Identifier for this enrollment Integer
user[id] Corresponding Canvas user id for this enrollment. Integer
listing[id] Identifier for the listing Integer
listing[title] The name of the listing String
listing[type] The type of listing (Course or Program) String
listing[canvas_course_id] Canvas course ID (nil for Program enrollments) String
enrolled_at The time of enrollment (UTC) Datetime
status Enrollment status (active, dropped or concluded) String
requirement_details[requirement_count] The total number of requirements for the enrollment Integer
requirement_details[requirement_completed_count] The number of completed requirements Integer
requirement_details[requirement_completed_percentage] The percentage of completed requirements (0,100) Integer

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "enrollment": {
    "id": 4,
    "user": {
      "id": 1
    },
    "listing": {
      "id": 46,
      "title": "Course 44",
      "type": "Course",
      "canvas_course_id": 28
    },
    "enrolled_at": "2024/01/01 00:00:00 +0000",
    "status": "active",
    "requirement_details": {
      "requirement_count": 10,
      "requirement_completed_count": 4,
      "requirement_completed_percentage": 40
    }
  }
}

Creating an enrollment

Endpoint

POST https://www.my-catalog.edu/api/v1/enrollments

Parameters

Name Description Type
create_order Create an order record for this enrollment, defaults to true Boolean
send_email Send an enrollment email to the user, defaults to true Boolean
enrollment[listing_id] required Id of the Listing Integer
enrollment[canvas_user_id] required Id of the Canvas user Integer

Request

Route

POST https://www.my-catalog.edu/api/v1/enrollments

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "enrollment": {
    "listing_id": 47,
    "canvas_user_id": 1
  }
}

Response

Response Fields

Name Description Type
id Identifier for this enrollment Integer
user[id] Corresponding Canvas user id for this enrollment. Integer
listing[id] Identifier for the listing Integer
listing[title] The name of the listing String
listing[type] The type of listing (Course or Program) String
listing[canvas_course_id] Canvas course ID (nil for Program enrollments) String
enrolled_at The time of enrollment (UTC) Datetime
status Enrollment status (active, dropped or concluded) String
requirement_details[requirement_count] The total number of requirements for the enrollment Integer
requirement_details[requirement_completed_count] The number of completed requirements Integer
requirement_details[requirement_completed_percentage] The percentage of completed requirements (0,100) Integer

Status

201

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "enrollment": {
    "id": 5,
    "user": {
      "id": 1
    },
    "listing": {
      "id": 47,
      "title": "Course 45",
      "type": "Course",
      "canvas_course_id": 29
    },
    "enrolled_at": "2024/01/01 00:00:00 +0000",
    "status": "active",
    "requirement_details": {
      "requirement_count": 10,
      "requirement_completed_count": 4,
      "requirement_completed_percentage": 40
    }
  }
}

Tags

The request parameters should be sent as JSON in the request body.

Updating a specific tag

Endpoint

PUT https://www.my-catalog.edu/api/v1/tags/:id

Parameters

Name Description Type
name required New tag name (minimum 1 and maximum 255 characters) String

Request

Route

PUT https://www.my-catalog.edu/api/v1/tags/17

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "name": "New tag name"
}

Response

Response Fields

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Products associate to this tag Array
assigned_listings[id] Product id Integer
assigned_listings[title] Product title String
assigned_listings[type] Product type (COURSE or PROGRAM) String
assigned_listings[canvas_course_id] Product Canvas course id Integer
assigned_listings[archived_at] Archival date (if product is archived) Datetime
assigned_categories Categories associate to this tag Array
assigned_categories[id] Category id Integer
assigned_categories[account_id] Account id Integer
assigned_categories[tag_id] Tag id Integer
assigned_categories[created_at] Category created at Datetime
assigned_categories[updated_at] Category updated at Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": 17,
  "account_id": 1,
  "name": "New tag name",
  "assigned_listings": [
    {
      "id": 3,
      "title": "Course 1",
      "type": "COURSE",
      "canvas_course_id": 4
    },
    {
      "id": 4,
      "title": "Course 2",
      "type": "COURSE",
      "canvas_course_id": 5,
      "archived_at": "2023-08-20T06:33:38.991906Z"
    }
  ],
  "assigned_categories": [
    {
      "id": 12,
      "account_id": 5,
      "tag_id": 17,
      "created_at": "2023-08-22T06:33:38.991906Z",
      "updated_at": "2023-08-24T06:33:38.991906Z"
    }
  ],
  "created_at": "2023-08-07T09:45:45.535989Z",
  "updated_at": "2023-08-07T09:45:45.535989Z"
}

Deleting a specific tag

Endpoint

DELETE https://www.my-catalog.edu/api/v1/tags/:id

Request

Route

DELETE https://www.my-catalog.edu/api/v1/tags/17

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Returns empty list to indicate associated products to this tag are deleted Array
assigned_categories Returns empty list to indicate associated categories to this tag are deleted Array
is_deleted Returns true to indicate tag is deleted Boolean

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": 17,
  "account_id": 1,
  "name": "Tag 1",
  "assigned_listings": [

  ],
  "assigned_categories": [

  ],
  "created_at": "2023-08-07T09:45:45.535989Z",
  "updated_at": "2023-08-07T09:45:45.535989Z",
  "is_deleted": true
}

Deleting multiple tags

Endpoint

DELETE https://www.my-catalog.edu/api/v1/tags/bulk

Parameters

Name Description Type
ids required Array of tag IDs to delete Array

Request

Route

DELETE https://www.my-catalog.edu/api/v1/tags/bulk

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "ids": [
    17,
    18
  ]
}

Response

Response Fields

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Returns empty list to indicate associated products to this tag are deleted Array
assigned_categories Returns empty list to indicate associated categories to this tag are deleted Array
is_deleted Returns true to indicate tag is deleted Boolean

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "tags": [
    {
      "id": 17,
      "account_id": 1,
      "name": "Tag 1",
      "assigned_listings": [

      ],
      "assigned_categories": [

      ],
      "created_at": "2023-08-07T09:45:45.535989Z",
      "updated_at": "2023-08-07T09:45:45.535989Z",
      "is_deleted": true
    },
    {
      "id": 18,
      "account_id": 1,
      "name": "Tag 2",
      "assigned_listings": [

      ],
      "assigned_categories": [

      ],
      "created_at": "2023-08-07T09:45:45.535989Z",
      "updated_at": "2023-08-07T09:45:45.535989Z",
      "is_deleted": true
    }
  ]
}

Listing tags

Endpoint

GET https://www.my-catalog.edu/api/v1/tags

Parameters

Name Description Type
product_ids List of product ids (maximum 20 ids) Array
name Search value which will be searched in tag name and associated products names String
has_category Tag has category or not Boolean
updated_at_from Updated at from Datetime
updated_at_to Updated at to Datetime
created_at_from Created at from Datetime
created_at_to Created at to Datetime

Request

Route

GET https://www.my-catalog.edu/api/v1/tags?product_ids=1%2C2%2C3&name=tag+1&has_category=true&updated_at_from=2023-08-06T14%3A46%3A59.944581%2B02%3A00&updated_at_to=2023-08-10T14%3A46%3A59.944581-05%3A00&created_at_from=2023-08-05T14%3A46%3A59.944581%2B02%3A00&created_at_to=2023-08-09T14%3A46%3A59.944581-05%3A00

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Query Parameters

product_ids=1,2,3
name=tag 1
has_category=true
updated_at_from=2023-08-06T14:46:59.944581+02:00
updated_at_to=2023-08-10T14:46:59.944581-05:00
created_at_from=2023-08-05T14:46:59.944581+02:00
created_at_to=2023-08-09T14:46:59.944581-05:00

Response

Response Fields

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Products associate to this tag Array
assigned_listings[id] Product id Integer
assigned_listings[title] Product title String
assigned_listings[type] Product type (COURSE or PROGRAM) String
assigned_listings[canvas_course_id] Product Canvas course id Integer
assigned_listings[archived_at] Archival date (if product is archived) Datetime
assigned_categories Categories associate to this tag Array
assigned_categories[id] Category id Integer
assigned_categories[account_id] Account id Integer
assigned_categories[tag_id] Tag id Integer
assigned_categories[created_at] Category created at Datetime
assigned_categories[updated_at] Category updated at Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "tags": [
    {
      "id": 17,
      "account_id": 1,
      "name": "Tag 1",
      "assigned_listings": [
        {
          "id": 3,
          "title": "Course 1",
          "type": "COURSE",
          "canvas_course_id": 4
        },
        {
          "id": 4,
          "title": "Course 2",
          "type": "COURSE",
          "canvas_course_id": 5,
          "archived_at": "2023-08-20T06:33:38.991906Z"
        }
      ],
      "assigned_categories": [
        {
          "id": 12,
          "account_id": 5,
          "tag_id": 17,
          "created_at": "2023-08-22T06:33:38.991906Z",
          "updated_at": "2023-08-24T06:33:38.991906Z"
        }
      ],
      "created_at": "2023-08-07T09:45:45.535989Z",
      "updated_at": "2023-08-07T09:45:45.535989Z"
    }
  ]
}

Getting a specific tag

Endpoint

GET https://www.my-catalog.edu/api/v1/tags/:id

Request

Route

GET https://www.my-catalog.edu/api/v1/tags/17

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Products associate to this tag Array
assigned_listings[id] Product id Integer
assigned_listings[title] Product title String
assigned_listings[type] Product type (COURSE or PROGRAM) String
assigned_listings[canvas_course_id] Product Canvas course id Integer
assigned_listings[archived_at] Archival date (if product is archived) Datetime
assigned_categories Categories associate to this tag Array
assigned_categories[id] Category id Integer
assigned_categories[account_id] Account id Integer
assigned_categories[tag_id] Tag id Integer
assigned_categories[created_at] Category created at Datetime
assigned_categories[updated_at] Category updated at Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": 17,
  "account_id": 1,
  "name": "Tag 1",
  "assigned_listings": [
    {
      "id": 3,
      "title": "Course 1",
      "type": "COURSE",
      "canvas_course_id": 4
    },
    {
      "id": 4,
      "title": "Course 2",
      "type": "COURSE",
      "canvas_course_id": 5,
      "archived_at": "2023-08-20T06:33:38.991906Z"
    }
  ],
  "assigned_categories": [
    {
      "id": 12,
      "account_id": 5,
      "tag_id": 17,
      "created_at": "2023-08-22T06:33:38.991906Z",
      "updated_at": "2023-08-24T06:33:38.991906Z"
    }
  ],
  "created_at": "2023-08-07T09:45:45.535989Z",
  "updated_at": "2023-08-07T09:45:45.535989Z"
}

Creating a tag

Endpoint

POST https://www.my-catalog.edu/api/v1/tags

Parameters

Name Description Type
name required Tag name (minimum 1 and maximum 255 characters) String
product_ids List of product ids associate to this tag Array

Request

Route

POST https://www.my-catalog.edu/api/v1/tags

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "name": "Tag 1",
  "product_ids": [
    1,
    2,
    3
  ]
}

Response

Response Fields

Name Description Type
id Tag id Integer
account_id Account id Integer
name Tag name String
created_at Tag created at Datetime
updated_at Tag updated at Datetime
assigned_listings Products associate to this tag Array
assigned_listings[id] Product id Integer
assigned_listings[title] Product title String
assigned_listings[type] Product type (COURSE or PROGRAM) String
assigned_listings[canvas_course_id] Product Canvas course id Integer
assigned_listings[archived_at] Archival date (if product is archived) Datetime
assigned_categories Returns empty list to indicate there are no associated categories to the newly created tag Array

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "id": 17,
  "account_id": 1,
  "name": "Tag 1",
  "assigned_listings": [
    {
      "id": 1,
      "title": "Course 1",
      "type": "COURSE",
      "canvas_course_id": 2
    },
    {
      "id": 2,
      "title": "Course 2",
      "type": "COURSE",
      "canvas_course_id": 3
    },
    {
      "id": 3,
      "title": "Program 1",
      "type": "PROGRAM"
    }
  ],
  "assigned_categories": [

  ],
  "created_at": "2023-08-07T09:45:45.535989Z",
  "updated_at": "2023-08-07T09:45:45.535989Z"
}

Users

Deleting a specific user with dependencies

This endpoint will delete requested existing Catalog user if the user is in the root catalog or one of sub-catalog of the root catalog that api key is generated.
When only_orders_and_enrollments parameter is TRUE, it will delete only user dependencies that are orders, enrollments, payments, bulk invitations that he created, and applicants (wait list) for that user.
When only_orders_and_enrollments is FALSE or not specified, it will delete user dependencies including user itself and its related account admins.

Endpoint

DELETE https://www.my-catalog.edu/api/v1/users/:id

Parameters

Name Description Type
id required Catalog user id Integer
only_orders_and_enrollments Delete only orders and enrollments (user dependencies) except user and related account admins OR delete user dependencies including user and related account admins Boolean

Request

Route

DELETE https://www.my-catalog.edu/api/v1/users/1

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Response

Status

200

Headers

Content-Type: application/json

List users

Endpoint

GET https://www.my-catalog.edu/api/v1/users

Parameters

Name Description Type
registered_in_catalog If true, only queries users registered through Catalog. If false, only queries users registered through Canvas. If not specified, queries all users. Boolean
canvas_user_id Canvas user id Integer
created_at_from Created at from. Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC. Datetime
created_at_to Created at to. Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC. Datetime
updated_at_from Updated at from. Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC. Datetime
updated_at_to Updated at to. Suggested format YYYY-MM-DDTHH:MM:SSZ, e.g. 2018-01-01T00:00:00Z. System time zone is UTC. Datetime

Request

Route

GET https://www.my-catalog.edu/api/v1/users?canvas_user_id=2&registered_in_catalog=true&created_at_from=2018-01-01T00%3A00%3A00Z&created_at_to=2024-05-01T00%3A00%3A00Z&updated_at_from=2018-01-01T00%3A00%3A00Z&updated_at_to=2024-05-01T00%3A00%3A00Z

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Query Parameters

canvas_user_id=2
registered_in_catalog=true
created_at_from=2018-01-01T00:00:00Z
created_at_to=2024-05-01T00:00:00Z
updated_at_from=2018-01-01T00:00:00Z
updated_at_to=2024-05-01T00:00:00Z

Response

Response Fields

Name Description Type
id Catalog user id Integer
root_account_id Root account id Integer
canvas_user_id Canvas user id Integer
registered_account_id The account where the user was registered Integer
canvas_root_account_uuid Canvas root account UUID String
canvas_user_uuid Canvas user UUID String
user_name Full name String
first_name First name String
last_name Last name String
email_address E-mail address String
custom_fields Custom field values, e.g. { "phone": "(999) 123-4567" } Object
created_at Date/time of creation Datetime
updated_at Date/time of last update Datetime
time_zone User timezone String
merged_into_user_id The user where the user merged into Integer

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "users": [
    {
      "id": 2,
      "root_account_id": 58,
      "canvas_user_id": 2,
      "registered_account_id": 58,
      "canvas_root_account_uuid": "GUxMJJhiZ8ugUdRADskc0nJrcMXuYYIwV15aWiMO",
      "canvas_user_uuid": "573SBAKMeMX3pAa6iOcml1a81xzsVaomatXUBhUT",
      "user_name": "Firstname Lastname",
      "first_name": "Firstname",
      "last_name": "Lastname",
      "email_address": "user1@example.com",
      "custom_fields": {
        "favorite_color": "#BADA55",
        "code_of_conduct": "1",
        "age": "19"
      },
      "created_at": "2024-04-11T15:33:45.503Z",
      "updated_at": "2024-04-11T15:33:45.563514Z",
      "merged_into_user_id": 4,
      "time_zone": "Etc/UTC"
    }
  ]
}

Updating a specific user

This endpoint can be used to resolve login issues for users who encounter the “Current user has been deleted or merged. Please re-login” error after attempting to log in to the Catalog. To fix this issue, set the clear_merged_into_user_id parameter to true.

Endpoint

PUT https://www.my-catalog.edu/api/v1/users/:id

Parameters

Name Description Type
id required Catalog user id Integer
clear_merged_into_user_id It will clear merged_into_user_id field of user if set to true Boolean

Request

Route

PUT https://www.my-catalog.edu/api/v1/users/3

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Catalog user id Integer
root_account_id Root account id Integer
canvas_user_id Canvas user id Integer
registered_account_id The account where the user was registered Integer
canvas_root_account_uuid Canvas root account UUID String
canvas_user_uuid Canvas user UUID String
user_name Full name String
first_name First name String
last_name Last name String
email_address E-mail address String
custom_fields Custom field values, e.g. { "phone": "(999) 123-4567" } Object
created_at Date/time of creation Datetime
updated_at Date/time of last update Datetime
time_zone User timezone String
merged_into_user_id The user where the user merged into Integer

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "user": {
    "id": 3,
    "root_account_id": 59,
    "canvas_user_id": 2,
    "registered_account_id": 59,
    "canvas_root_account_uuid": "GUxMJJhiZ8ugUdRADskc0nJrcMXuYYIwV15aWiMO",
    "canvas_user_uuid": "573SBAKMeMX3pAa6iOcml1a81xzsVaomatXUBhUT",
    "user_name": "Firstname Lastname",
    "first_name": "Firstname",
    "last_name": "Lastname",
    "email_address": "user1@example.com",
    "custom_fields": {
      "favorite_color": "#BADA55",
      "code_of_conduct": "1",
      "age": "19"
    },
    "created_at": "2024-04-11T15:33:45.503Z",
    "updated_at": "2024-04-11T15:33:45.563514Z",
    "merged_into_user_id": null,
    "time_zone": "Etc/UTC"
  }
}

Registering a user

Endpoint

POST https://www.my-catalog.edu/api/v1/users

Parameters

Name Description Type
user_name required Full user name String
first_name First name String
last_name Last name String
email_address required E-mail address (will also serve as login) String
registered_account_id ID of subcatalog to associate with user (optional). If not specified, the root account ID used to generate the API key will be registered_account_id Integer
custom_fields Hash of custom field values, e.g. { "phone": "867-5309" } (optional) Object

Request

Route

POST https://www.my-catalog.edu/api/v1/users

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "user_name": "Firstname Lastname",
  "first_name": "Firstname",
  "last_name": "Lastname",
  "email_address": "user1@example.com",
  "registered_account_id": 60,
  "custom_fields": {
    "favorite_color": "#BADA55",
    "code_of_conduct": "1",
    "age": "19"
  }
}

Response

Response Fields

Name Description Type
id Catalog user id Integer
root_account_id Root account id Integer
canvas_user_id Canvas user id Integer
registered_account_id The account where the user was registered Integer
canvas_root_account_uuid Canvas root account UUID String
canvas_user_uuid Canvas user UUID String
user_name Full name String
first_name First name String
last_name Last name String
email_address E-mail address String
custom_fields Custom field values, e.g. { "phone": "(999) 123-4567" } Object
created_at Date/time of creation Datetime
updated_at Date/time of last update Datetime
confirmation_url User confirmation url String
terms_of_use User term of use flag Boolean
locale User locale based on registered account String

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "user": {
    "id": 4,
    "root_account_id": 60,
    "canvas_user_id": 2,
    "registered_account_id": 60,
    "canvas_root_account_uuid": "GUxMJJhiZ8ugUdRADskc0nJrcMXuYYIwV15aWiMO",
    "canvas_user_uuid": "573SBAKMeMX3pAa6iOcml1a81xzsVaomatXUBhUT",
    "user_name": "Firstname Lastname",
    "first_name": "Firstname",
    "last_name": "Lastname",
    "email_address": "user1@example.com",
    "custom_fields": {
      "favorite_color": "#BADA55",
      "code_of_conduct": "1",
      "age": "19"
    },
    "created_at": "2024-04-11T15:33:45.503Z",
    "updated_at": "2024-04-11T15:33:45.563514Z",
    "confirmation_url": "http://service.com/register/OBtRMuSPiFUAyStz47cbAiOHM",
    "terms_of_use": true,
    "locale": "en"
  }
}

Getting a specific user

Endpoint

GET https://www.my-catalog.edu/api/v1/users/:id

Parameters

Name Description Type
id required Catalog user id Integer

Request

Route

GET https://www.my-catalog.edu/api/v1/users/5

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Catalog user id Integer
root_account_id Root account id Integer
canvas_user_id Canvas user id Integer
registered_account_id The account where the user was registered Integer
canvas_root_account_uuid Canvas root account UUID String
canvas_user_uuid Canvas user UUID String
user_name Full name String
first_name First name String
last_name Last name String
email_address E-mail address String
custom_fields Custom field values, e.g. { "phone": "(999) 123-4567" } Object
created_at Date/time of creation Datetime
updated_at Date/time of last update Datetime
time_zone User timezone String
merged_into_user_id The user where the user merged into Integer

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "user": {
    "id": 5,
    "root_account_id": 61,
    "canvas_user_id": 2,
    "registered_account_id": 61,
    "canvas_root_account_uuid": "GUxMJJhiZ8ugUdRADskc0nJrcMXuYYIwV15aWiMO",
    "canvas_user_uuid": "573SBAKMeMX3pAa6iOcml1a81xzsVaomatXUBhUT",
    "user_name": "Firstname Lastname",
    "first_name": "Firstname",
    "last_name": "Lastname",
    "email_address": "user1@example.com",
    "custom_fields": {
      "favorite_color": "#BADA55",
      "code_of_conduct": "1",
      "age": "19"
    },
    "created_at": "2024-04-11T15:33:45.503Z",
    "updated_at": "2024-04-11T15:33:45.563514Z",
    "merged_into_user_id": 4,
    "time_zone": "Etc/UTC"
  }
}

Progresses

Getting a specific progress

Endpoint

GET https://www.my-catalog.edu/api/v1/progresses/:id

Request

Route

GET https://www.my-catalog.edu/api/v1/progresses/2

Headers

Authorization: Token token="my-token"
Host: www.my-catalog.edu

Response

Response Fields

Name Description Type
id Progress ID Integer
account_id Catalog Account ID Integer
canvas_user_id The Canvas User ID of the user who initiated the job Integer
completion_percent The completion percent of the job Integer
workflow_state The status of the progress String
payload Any data or errors returned by the job Array
created_at The creation date for the progress job Datetime
updated_at The last time the progress job was updated Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "progress": {
    "id": 2,
    "account_id": 62,
    "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"
  }
}

Certificates

Getting a listing certificate

Endpoint

GET https://www.my-catalog.edu/api/v1/certificates

Parameters

Name Description Type
certificate[listing_id] required Id of the Listing Integer

Request

Route

GET https://www.my-catalog.edu/api/v1/certificates?certificate[listing_id]=48

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Query Parameters

certificate={"listing_id"=>"48"}

Response

Response Fields

Name Description Type
certificate[id] Certificate ID Integer
certificate[listing_id] Corresponding listing ID Integer
certificate[name] Certificate name String
certificate[active] Whether the certificate is enabled String
certificate[template] HTML template used to generate issued certificates String
certificate[pdf_settings] An object containing extra params for PDF generation Object
certificate[created_at] The creation date of the certificate Datetime
certificate[updated_at] The last time the certificate was updated Datetime
certificate[days_to_expire] Number of days for which issued certificates remain valide Integer
certificate[expires_at] A fixed datetime when issued certificates expire Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "certificate": {
    "id": 2,
    "listing_id": 48,
    "name": "Certificate of Training",
    "active": true,
    "template": "Congrats, {{student_name}}!",
    "pdf_settings": {
    },
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "days_to_expire": null,
    "expires_at": null
  }
}

Request

Route

GET https://www.my-catalog.edu/api/v1/certificates?certificate[listing_id]=48

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Query Parameters

certificate={"listing_id"=>"48"}

Response

Response Fields

Name Description Type
certificate[id] Certificate ID Integer
certificate[listing_id] Corresponding listing ID Integer
certificate[name] Certificate name String
certificate[active] Whether the certificate is enabled String
certificate[template] HTML template used to generate issued certificates String
certificate[pdf_settings] An object containing extra params for PDF generation Object
certificate[created_at] The creation date of the certificate Datetime
certificate[updated_at] The last time the certificate was updated Datetime
certificate[days_to_expire] Number of days for which issued certificates remain valide Integer
certificate[expires_at] A fixed datetime when issued certificates expire Datetime

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "certificate": {
    "id": 2,
    "listing_id": 48,
    "name": "Certificate of Training",
    "active": true,
    "template": "Congrats, {{student_name}}!",
    "pdf_settings": {
    },
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "days_to_expire": null,
    "expires_at": null
  }
}

Deleting a certificate

Endpoint

DELETE https://www.my-catalog.edu/api/v1/certificates

Parameters

Name Description Type
certificate[listing_id] required Id of the Listing Integer
nullify_requirements_completed_at Should nullify the requirements_completed_at for the enrollments, defaults to false Boolean

Request

Route

DELETE https://www.my-catalog.edu/api/v1/certificates

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "certificate": {
    "listing_id": 49
  },
  "nullify_requirements_completed_at": true
}

Response

Status

204

Revoking users certificate

Endpoint

PUT https://www.my-catalog.edu/api/v1/certificates/revoke_users_certificate

Parameters

Name Description Type
certificate[listing_id] required Id of the Listing Integer
certificate[canvas_user_ids] required List of Canvas User Id's Array

Request

Route

PUT https://www.my-catalog.edu/api/v1/certificates/revoke_users_certificate

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "certificate": {
    "listing_id": 50,
    "canvas_user_ids": [
      1
    ]
  }
}

Response

Response Fields

Name Description Type
revoked_certificates[canvas_user_id] Canvas User ID Integer
revoked_certificates[canvas_course_id] Canvas Course ID Integer
revoked_certificates[listing_id] Catalog Product Listing ID Integer

Status

200

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "revoked_certificates": [
    {
      "canvas_user_id": 1,
      "canvas_course_id": 1001,
      "listing_id": 50
    }
  ]
}

Creating a certificate

Endpoint

POST https://www.my-catalog.edu/api/v1/certificates

Parameters

Name Description Type
certificate[listing_id] required Id of the Listing Integer
certificate[name] required Name of the Certificate String
certificate[active] State of the Certificate, defaults to true Boolean
certificate[template] required Template for Certificate contents String
certificate[pdf_settings][orientation] 'Landscape' or 'Portrait' mode for PDF. Defaults to Landscape. String
days_to_expire Days until the certificate expires after it is awarded. Defaults to null. Must not be present when expires_at is present. Integer
expires_at Date of certificate expiration. Defaults to null. Must not be present when days_to_expire is present. Datetime

Request

Route

POST https://www.my-catalog.edu/api/v1/certificates

Headers

Authorization: Token token="my-token"
Content-Type: application/json
Host: www.my-catalog.edu

Body

{
  "certificate": {
    "listing_id": 51,
    "name": "API Name",
    "active": true,
    "template": "<H1>This is a template</h1>",
    "pdf_settings": {
      "orientation": "Landscape"
    }
  }
}

Response

Response Fields

Name Description Type
certificate[id] Certificate ID Integer
certificate[listing_id] Corresponding listing ID Integer
certificate[name] Certificate name String
certificate[active] Whether the certificate is enabled String
certificate[template] HTML template used to generate issued certificates String
certificate[pdf_settings] An object containing extra params for PDF generation Object
certificate[created_at] The creation date of the certificate Datetime
certificate[updated_at] The last time the certificate was updated Datetime
certificate[days_to_expire] Number of days for which issued certificates remain valide Integer
certificate[expires_at] A fixed datetime when issued certificates expire Datetime

Status

201

Headers

Content-Type: application/json; charset=utf-8

Body

{
  "certificate": {
    "id": 5,
    "listing_id": 51,
    "name": "API Name",
    "active": true,
    "template": "<H1>This is a template</h1>",
    "pdf_settings": {
      "orientation": "Landscape"
    },
    "created_at": "2024/01/01 00:00:00 +0000",
    "updated_at": "2024/01/01 00:00:00 +0000",
    "days_to_expire": null,
    "expires_at": null
  }
}