--- title: "Gets all authorized catalogs" method: GET path: "/catalogs" tags: ["Catalogs"] --- # Gets all authorized catalogs `GET /catalogs` ## Request - Base URL: `https://euwest.api.elasticpath.com` - URL: `https://euwest.api.elasticpath.com/catalogs` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Retrieves a list of all the catalogs that you are authorized to view. A new catalog keeps two published releases. Set `max_published_releases` to 1, 2, or 3. A catalog that has never stored `max_published_releases` keeps the current release and two releases prior to the current release. You can see the differences between the last 2 consecutive catalog releases using the delta link returned in the response of a [publish a catalog](/docs/api/pxm/catalog/publish-release) endpoint. You can use the `is_full_delta` attribute returned from the `get a release of a catalog` endpoint to determine if you need to refresh the data in your company system before publishing a catalog release and injecting fresh data in a delta link. The `is_full_delta` attribute tells you if this is a full publish of a catalog release. Using a search service as an example, if the `is_full_delta` attribute is `true`, you should remove all data about that catalog from the search service before publishing a catalog release and injecting fresh data from the delta file. See [Publish a catalog](/docs/api/pxm/catalog/publish-release). If the `is_full_publish` attribute returned in the response is `false`, data from the previous catalog release overlaid the existing data in the delta file. The `is_full_publish` attribute is always `true` the first time a catalog is published. When determining whether delta data needs to be refreshed, ignore this attribute and always use the `is_full_delta` attribute. ### Filtering This endpoint supports filtering. For general filtering syntax, see [Filtering](/guides/Getting-Started/filtering). The following operators and attributes are available when filtering on this endpoint. | Operator | Description | Supported Attributes | Example | |:---|:------------------------------------------------------------------------------------------------|:---------------------------------------------------------|:--- | | `eq` | Checks if the values of two operands are equal. If they are, the condition is true. | `name`, | `filter=eq(name,some-name)` | | `in` | Checks if the values are included in the specified list. If they are, the condition is true. | `name` | `filter=in(name,some-name,some-name2)` | | `like` | Checks if the operand contains the specified string. Wildcards are supported | `name` | `filter=like(name,*some-name*)` | ## Query parameters - `filter` string - `page[limit]` integer - `page[offset]` integer ## Response `200` The list of catalogs. - CatalogListData: Container for a list of catalogs. - `data` Catalog[], required - `id` string, required: A unique identifier of a catalog. - `attributes` object, required - `name` string, required: The name of a catalog. - `description` string: A brief description of the catalog, such as the purpose of the catalog. - `hierarchy_ids` string[], required: The unique identifiers of the hierarchies associated with a catalog. - `pricebook_id` string: The unique identifier of a price book associated with a catalog. If no price book is selected, the catalog is displayed without prices. - `pricebook_ids` object[]: If you want multiple price books for different scenarios, such as seasonal sales, business versus retail pricing, and reward programs, when creating a catalog, you can specify up to five price books. You must configure a priority for your price books. Product prices are displayed in the catalog according to the priority of the price books. - `id` string, uuid, required: A unique identifier of a price book. - `priority` integer, required: Priority is a number and the price book with the highest number has the highest priority. - `locales` object: Product Experience Manager supports localization of products and hierarchies. If you store supports multiple languages, you can localize product names and descriptions. - `created_at` string, date-time, required: The date and time a catalog is created. - `updated_at` string, date-time, required: The date and time a catalog was updated. - `owner` 'store' | 'organization', nullable: The owner of this resource, can be either `organization` or `store`. - `enable_price_segmentation` boolean: This indicates whether the catalog will support price segmentation using catalog rules to define which pricebook(s) to use for pricing - `include_draft_products` boolean: When `true`, publishing this catalog includes products in `draft` status in the catalog release. When `false` or omitted, only `live` products are included in the release (default). - `max_published_releases` integer, nullable: The maximum number of published releases kept for this catalog. Omitted when the catalog has never stored a maximum. - `allow_search_overrides` boolean: When `true`, search overrides are allowed for this catalog. Defaults to `false`. - `relationships` object: Relationships are established between different catalog entities. For example, a catalog rule and a price book are related to a catalog, as both are associated with it. - `rules` object: The catalog rules related to a catalog. - `links` RelatedLink: A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas. - `related` string, required: A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas. - `releases` object: When a catalog is published, a catalog release is created. This is a URL to all catalog published releases available for this catalog. - `links` RelatedLink: A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas. - `related` string, required: A URL to a related object, for example, catalog rules, hierarchies, price books, products and deltas. - `meta` object - `count` integer: The number releases available for a catalog. - `type` 'catalog', required - `meta` PageMeta: Contains the results for the entire collection. - `results` object: Total number of results for the entire collection. - `total` integer: Total number of results for the entire collection. - `page` object - `limit` integer: The maximum number of records for all pages. - `offset` integer: The current offset by number of pages. - `current` integer: The current number of pages. - `total` integer: The total number of records for the entire collection. - `links` Links: Links allow you to move between requests. - `self` string, uri-reference, nullable: Single entities use a `self` parameter with a link the specific resource. - `first` string, uri-reference, nullable: Always the first page. - `last` string, uri-reference, nullable: This is `null` if there is only one page. - `prev` string, uri-reference, nullable: This is `null` if there is only one page. - `next` string, uri-reference, nullable: This is `null` if there is only one page. ## Other responses - `default`: An unexpected error. --- [API](https://skmtc.dev/elasticpath/apis/catalogs-introduction.md) - [All operations](https://skmtc.dev/elasticpath/apis/catalogs-introduction/llms.txt) - [OpenAPI document](https://skmtc.dev/elasticpath/apis/catalogs-introduction/revisions/eb541d5dea51?raw)