---
title: "Get Catalog"
method: GET
path: "/v1/catalog/{catalogId}"
tags: ["Catalogs"]
---

# Get Catalog

`GET /v1/catalog/{catalogId}`

Retrieve the specified catalog. This will include the alias configuration, how the item parameters should be represented in a GUI, as well as read-only information about how brands, categories and merchants have been setup in the catalog system.

## Path parameters

- `catalogId` number, required

## Response `200`

Catalog retrieved successfully.

- CatalogOut
  - `Aliases` object, required — The alias configuration for the catalog. The alias configuration is used to map the raw data into kevel standardized keys, so for example if your unique identifier is **catalog_id** and your name is **catalog_name**, you can set the alias configuration to **{ "Id": "catalog_id", "Name": "catalog_name" }** to map your values to the standardized keys.
    - `Id` string, required — The unique identifier.
    - `Brand` KeyIdName — Brand alias configuration, which allows mapping of the standard brand id and brand name keys to the corresponding keys stored in the catalog item.
      - `Id` string — The unique identifier.
      - `Name` string — The name.
    - `Category` object — Category alias configuration, which allows mapping of the standard category id, name, and hierarchy array keys to the corresponding keys stored in the catalog item.
      - `Id` string — The unique identifier.
      - `Name` string — The name.
      - `Categories` string — Array of categories that signify a category hierarchy.
    - `Image` string — Image alias configuration, which allows mapping of the standard image url to the corresponding key stored in the catalog item.
    - `Merchant` object — Merchant alias configuration, which allows mapping of the standard merchant id and merchant name keys to the corresponding keys stored in the catalog item.
      - `Id` string — The unique identifier.
      - `Name` string — The name.
    - `Name` string — Name alias configuration, which allows mapping of the standard name to the corresponding key stored in the catalog item.
    - `Product` object — Product alias configuration, which allows mapping of the standard product id and product name keys to the corresponding keys stored in the catalog item.
      - `Id` string — The unique identifier.
      - `Name` string — The name.
  - `SearchableAttributes` CatalogSearchableAttribute[] — Declaration of extra attributes that will be present on items of the catalog that should be searchable.
    - union
      - object
        - `Attribute` string, required — The name of the searchable attribute.
        - `ReferenceId` number, required
        - `Type` 'Referenced', required — Referenced type of searchable attribute.
        - `Cardinality` union, required — The cardinality of the searchable attribute.
          - 'One' — One cardinality.
          - 'Many' — Many cardinality.
      - object
        - `Attribute` string, required — The name of the searchable attribute.
        - `Type` 'Text', required — Text type of searchable attribute.
        - `Cardinality` 'One', required — One cardinality.
      - object
        - `Attribute` string, required — The name of the searchable attribute.
        - `Type` 'Array' | 'Boolean' | 'Number' | 'Object' | 'String', required — The type of searchable attribute.
        - `Cardinality` union, required — The cardinality of the searchable attribute.
          - 'One' — One cardinality.
          - 'Many' — Many cardinality.
  - `Name` string, required — The name of the catalog.
  - `UIConfiguration` UIConfiguration[] — The UI configuration for the catalog.
    - `Key` string — The key of the column to display.
    - `AllowedValues` union — When a filter has a dropdown of items, the list of values will be limited to this list of IDs.
      - number[]
      - string[]
    - `AncestorsKey` string — Reference to the attribute name which represents the ancestors of a given item. Used in the display of filters where the items are of a hierarchical nature.
    - `DisplayColumn` boolean — Whether or not to display the attribute when viewing the record.
    - `DisplayFilter` boolean — Whether or not to display the filter for the attribute.
    - `FilterByOne` boolean — Whether or not to restrict filtering to a single value.
    - `FilterByRange` boolean — Whether or not to display the distinct values for the attribute in the filter dropdown.
    - `HideReferenceIds` boolean — Whether or not to hide the reference IDs so that only the label is shown.
    - `Label` string — Human readable label for the UI. If not provided, the attribute name will be used.
    - `Order` number — Order the component appears in the UI.
    - `Typeahead` boolean — Whether or not to display the distinct values for the attribute in the filter dropdown.
  - `Type` 'Product', required — The type of the catalog.
  - `Id` number, required
  - `Configuration` CatalogOutConfiguration — The configuration for the catalog.
    - `Categories` union — The category configuration.
      - CatalogInConfigurationItemFieldsType — The data is stored within the item as fields on the item object.
        - `Source` 'ItemFields', required
      - CatalogOutConfigurationReferencedType
        - `Source` 'Referenced', required
        - `ReferenceId` number, required
    - `Brands` union
      - object — The brand configuration.
        - `Source` 'ItemFields', required
      - object — The brand configuration.
        - `Source` 'Referenced', required
        - `ReferenceId` number, required
    - `Merchants` union
      - object — The merchant configuration.
        - `Source` 'ItemFields', required
      - object — The merchant configuration.
        - `Source` 'Referenced', required
        - `ReferenceId` number, required

## Other responses

- `400` — Bad request with errors.

---

[API](https://skmtc.net/kevel/apis/engine-apis.md) · [All operations](https://skmtc.net/kevel/apis/engine-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kevel/engine-apis/revisions/0ca55f45aa7d/schema)