---
title: "List catalogs"
method: GET
path: "/api/v1/catalogs"
tags: ["Catalogs"]
---

# List catalogs

`GET /api/v1/catalogs`

## Response `200`

catalogs listed

- object
  - `catalogs` object[], required
    - `id` integer, required — Identifier for this catalog
    - `name` string, required — The name of the catalog
    - `parent` object, nullable, required — Parent catalog (id and name), or null for a root catalog
      - `id` integer, required
      - `name` string, required
    - `created_at` string, required — Creation timestamp (ISO 8601)
    - `updated_at` string, required — Last-updated timestamp (ISO 8601)
    - `canvas_domain` string, required — Domain of the corresponding Canvas account
    - `canvas_id` integer, required — Id of the corresponding Canvas account
    - `settings` object, required — Catalog settings (inherited from ancestors unless overridden)
      - `privacy_policy_url` string, required
      - `terms_url` string, required
      - `currency` string, required — Three-character ISO currency code
      - `supported_payment_types` string, required
      - `time_zone` string, nullable, required
      - `country` string, required — Two-character ISO country code
      - `measurement` string, required
      - `email_from_name` string, required — Sender name on outgoing emails
      - `email_from_address` string, required
      - `allow_user_registration` boolean, required — Whether new users may self-register
      - `title_tag` string, nullable, required
      - `meta_description` string, nullable, required
      - `custom_head_content` string, nullable, required
      - `custom_body_content` string, nullable, required
      - `show_listings_in_parent` boolean, required
      - `order_id_prefix` string, nullable, required
      - `inherit_categories` boolean, required — Inherit categories from the parent catalog
      - `inherit_user_defined_fields` boolean, required — Inherit user-defined fields from the parent catalog
      - `inherit_purchase_order_institution_details` boolean, required
      - `beta_canvas_domain` string, nullable, required
      - `skus_enabled` boolean, required
      - `canvas_enrollment_events` boolean, required
      - `include_noncatalog_courses_in_dashboard` boolean, required
      - `external_idp_logout_workflow` boolean, required
      - `private_catalog` boolean, required
      - `bulk_purchase_disabled` boolean, required
      - `enroll_button_behavior` string, required
      - `external_registration_url` string, nullable, required
      - `external_registration_public_key` string, nullable, required
      - `redirect_external_registration_condition` string, required
      - `include_captcha` boolean, required
      - `user_registration_domain_restriction_type` string, required
      - `user_registration_domain_deny_list` string, required
      - `user_registration_domain_allow_list` string, required
      - `restrict_enrollment_to_user_registration_domain` boolean, required
      - `frame_ancestors` string, required
      - `email_reply_to` string, required
      - `has_sso_warning` boolean, required
      - `measurement_id` string, nullable, required
      - `redirect_non_admins_to_root_url` boolean, required
      - `canvas_feature_send_usage_metrics` boolean, required
      - `disable_passive_login` boolean, required
      - `new_storefront` boolean, required
      - `tags_permission_default_value` boolean, required
      - `cross_listing_permission_default_value` boolean, required
      - `inherit_storefront_theme` boolean, required
      - `canvas_authentication_provider_id` string, required
      - `udf_collection_level` string, required
      - `disable_drop_course_button` boolean, required
      - `google_tag_manager_id` string, nullable, required
      - `linkedin_partner_id` string, nullable, required
      - `enable_credentials` boolean, required
      - `enable_impact` boolean, required
      - `enable_pathways` boolean, required
      - `hide_missing_pathway` boolean, required
      - `storefront_product_recommendation_behavior` string, required
      - `storefront_product_recommendation_count` integer, required
      - `enable_recommendations` boolean, required
      - `product_page_recommendation_fallback` string, required
      - `product_page_recommendation_count` integer, required
      - `enable_recommendations_for_product_page` boolean, required
      - `hide_self_paced_label` boolean, required
      - `login_auth_providers` string, required
      - `multiple_promo_codes_enabled` boolean, required
      - `custom_instructor_label` string, nullable, required
      - `custom_instructor_label_plural` string, nullable, required
      - `purchase_seats_for_others_enabled` boolean, required
      - `hide_no_badges_text` boolean, required
      - `load_custom_scripts` boolean, required
      - `enable_purchase_orders` boolean, required
    - `user_defined_fields` object[], required — Custom fields collected from users, by direct assignment or inheritance
      - `list_order` integer, required — Display order
      - `name` string, required — Field name
      - `label` string, required — Label shown to the user
      - `field_type` string, required — HTML input type
      - `required` boolean, required — Whether the field is required
      - `required_message` string, required
      - `metadata` object, required — Field-type-specific metadata (e.g. options for dropdown fields)
      - `hide_in_user_workflow` boolean, required
    - `logo` string, nullable, required — URL of the catalog logo
    - `locale` string, required — Three-character locale for the catalog
    - `url` string, required — Public URL of the catalog
    - `measurement` string, required
    - `storefront_theme_id` string, nullable, required

---

[API](https://skmtc.net/instructure/apis/canvas-catalog-api.md) · [All operations](https://skmtc.net/instructure/apis/canvas-catalog-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/instructure/canvas-catalog-api/revisions/78578cd3e37a/schema)