How do I access the Catalog API?
If you are a Canvas admin and know how to use application program interface (API) commands, you can access the Canvas Catalog API to view information about your Catalog account.
The Canvas Catalog API documentation is contained on a single page, which you can print or scroll through. You can also auto-scroll to a section of documentation by clicking the links in the Table of Contents.
You can manage Subcatalog Admins directly within the product, including assigning or removing administrative access to specific subcatalogs. For automated or system-driven operations, the API allows developers to list account admins, associate an admin with an account, remove that association, or remove the admin entirely.
For more information, visit Catalog API documentation.
Open Admin
Click the User Name drop-down menu [1]. Then, click the Admin link [2].
Open API
Click the API tab.
View API Key Page
To use the API page, open and sort the tables by selecting any column header.
Review the expanded table that includes the additional column for extra context, and navigate through the content with improved accessibility support, including enhanced keyboard navigation and screen-reader compatibility.
View API Documentation
To view API Documentation, click on View API Documentation link.
View API Documentation Page
View the Catalog API documentation page [1] and the interactive table of contents [2].
To view content, scroll down the page.
Note: Canvas Catalog supports editing User Defined Fields (UDFs) through the API after learner registration is complete. This capability enables updates to information such as addresses, phone numbers, and license numbers that become available later in the learner lifecycle.
Manage Auto-Scroll to Content
To auto-scroll to a section in the documentation page and view subsections, click a section name link in the table of contents.
