Catalogs
Last updated
Was this helpful?
Last updated
Was this helpful?
GET /api/v1/catalogs HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
Listing catalogs
{
"catalogs": [
{
"id": 10,
"name": "Domain Account 10",
"parent": null,
"created_at": "2025/03/28 13:11:22 +0000",
"updated_at": "2025/03/28 13:11:22 +0000",
"canvas_domain": "www.canvas-domain-10.com",
"canvas_id": 10,
"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": "",
"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_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": "[]"
},
"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/test/logos/0f782fd2d557e4a990b119f4fb353bc8b2311a54.jpeg",
"locale": "en",
"url": "https://www.my-catalog.edu",
"measurement": "credit",
"storefront_theme_id": null
}
]
}GET /api/v1/catalogs/{id} HTTP/1.1
Host: replace_me
Authorization: YOUR_API_KEY
Accept: */*
Getting a specific catalog
{
"account": {
"id": 11,
"name": "Domain Account 15",
"parent": null,
"created_at": "2025/03/28 13:11:22 +0000",
"updated_at": "2025/03/28 13:11:22 +0000",
"canvas_domain": "www.canvas-domain-15.com",
"canvas_id": 15,
"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": "",
"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_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": "[]"
},
"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/test/logos/0a0ea491602e39c314957234500aa84fd2b97305.jpeg",
"locale": "en",
"url": "https://www.my-catalog.edu",
"measurement": "credit",
"storefront_theme_id": null
}
}