List catalogs

Retrieve lists of catalogs

Getting the filtered and sorted list of catalogs

get

Get the filtered list of catalogs for the specified tenant. Also, sorting and paging options are available. If none are given, default values will be used.

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name. Note: The tenant should always be written in lowercase.

Example: saasdev2
Query parameters
namestringOptional

Search by the name of the catalog. If you want to search for the name in a specific locale, you can just append the .<locale>, for example use name.de.

Example: name
descriptionstringOptional

Search by description of the catalog. If you want to search for the name in a specific locale, you can just append the .<locale>, for example use description.de.

Example: description
publishedSitestringOptional

Search by a site name. The equal operator is used here, therefore the site name must match.

visibilityFromstring · dateOptional

Search by start date of the visibility of the catalog. It must follow the pattern yyyy-MM-dd.

Example: 2022-01-28
visibilityTostring · dateOptional

Search by end date of the visibility of the catalog. It must follow the pattern yyyy-MM-dd.

Example: 2022-01-28
metadataUpdatedAtstring · dateOptional

Search by last update date of the catalog. It must follow the pattern yyyy-MM-dd.

Example: 2022-01-28
pageNumberinteger · int32 · min: 1Optional

Page number to be retrieved. The number of the first page is 1. Note: If the pageNumber parameter is passed, size of the pages must be specified in the pageSize parameter.

Default: 1
pageSizeinteger · int32 · min: 1Optional

Number of catalogs to be retrieved per page.

Default: 60
sortstringOptional

Fields to sort the response data by following order of the parameters from left to right. Can contain multiple fields in format: field name:sort direction separated by a comma. The colon with sort direction parameter is redundant and descending order is taken only if it is equal to desc or DESC. Ascending order is considered in any other case. Sorting by name parameter works properly only if the Accept-Language header is set to a specific language or is empty with default language specified in the configuration service.

Example: name,description:asc
Header parameters
X-Total-CountbooleanOptional

This flag specifies if the API client should receive a X-Total-Count header with the total number of elements that match the search filter.

Default: false
Accept-LanguagestringOptional

List of properties used to sort the results, separated by commas. Possible values:

  • * - each internationalized field is returned as a map containing all available translations
  • en, en,de - each internationalized field is returned as a map containing translation specified by a header value. If translation is not supported by tenant configuration then exception is thrown. First language is the one with highest priority.
  • fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5 - each internationalized field is returned as a map containing translation specified by a header value. If translation is not available exception is thrown. This list must contains any possible extension for internationalized fields included in sort param.
Default: *Example: *, 'en', 'en,de,fr', 'en-EN', 'fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5'
Responses
200
The search was successful.
application/json
get
GET /catalog/{tenant}/catalogs HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "id": "3456454",
    "name": {
      "en": "This is a catalog"
    },
    "description": {
      "en": "This catalog is used as an example"
    },
    "status": "VISIBLE",
    "visibility": {
      "visible": true,
      "from": "2022-02-24T20:44:43.169Z",
      "to": "2023-07-24T20:44:43.169Z"
    },
    "publishedSites": [
      "Main"
    ],
    "categoryIds": [
      "3249485"
    ],
    "metadata": {
      "version": 1,
      "updatedAt": "2022-02-24T20:44:43.169Z",
      "createdAt": "2022-02-24T20:44:43.169Z"
    }
  }
]

Retrieving all catalogs for category

get

Get all catalogs with the specified category that belong to the tenant.

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name. Note: The tenant should always be written in lowercase.

Example: saasdev2
categoryIdstringRequired

The unique id of the category, that will be matched with the category identifiers stored on catalogs.

Example: 787323
Query parameters
pageNumberinteger · int32 · min: 1Optional

Page number to be retrieved. The number of the first page is 1. Note: If the pageNumber parameter is passed, size of the pages must be specified in the pageSize parameter.

Default: 1
pageSizeinteger · int32 · min: 1Optional

Number of catalogs to be retrieved per page.

Default: 60
sortstringOptional

Fields to sort the response data by following order of the parameters from left to right. Can contain multiple fields in format: field name:sort direction separated by a comma. The colon with sort direction parameter is redundant and descending order is taken only if it is equal to desc or DESC. Ascending order is considered in any other case. Sorting by name parameter works properly only if the Accept-Language header is set to a specific language or is empty with default language specified in the configuration service.

Example: name,description:asc
Header parameters
X-Total-CountbooleanOptional

This flag specifies if the API client should receive a X-Total-Count header with the total number of elements that match the search filter.

Default: false
Accept-LanguagestringOptional

List of properties used to sort the results, separated by commas. Possible values:

  • * - each internationalized field is returned as a map containing all available translations
  • en, en,de - each internationalized field is returned as a map containing translation specified by a header value. If translation is not supported by tenant configuration then exception is thrown. First language is the one with highest priority.
  • fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5 - each internationalized field is returned as a map containing translation specified by a header value. If translation is not available exception is thrown. This list must contains any possible extension for internationalized fields included in sort param.
Default: *Example: *, 'en', 'en,de,fr', 'en-EN', 'fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5'
Responses
200
The search was successful.
application/json
get
GET /catalog/{tenant}/catalogs/categories/{categoryId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
[
  {
    "id": "text",
    "name": {
      "0": "t",
      "1": "e",
      "2": "x",
      "3": "t"
    },
    "description": {
      "0": "t",
      "1": "e",
      "2": "x",
      "3": "t"
    },
    "status": null,
    "visibility": {
      "visible": false,
      "from": "text",
      "to": "text"
    },
    "publishedSites": [
      "text"
    ],
    "metadata": {
      "version": 1,
      "updatedAt": "2025-07-12T08:14:10.889Z",
      "createdAt": "2025-07-12T08:14:10.889Z"
    },
    "categoryIds": [
      "text"
    ]
  }
]

Retrieving a catalog by id

get

Get the catalog with the specified unique id that belongs to the tenant.

Authorizations
Path parameters
tenantstringRequired

Your Emporix tenant's name. Note: The tenant should always be written in lowercase.

Example: saasdev2
catalogIdstringRequired

The unique id of the catalog.

Example: 787323
Responses
200
Catalog was successfully retrieved.
application/json
get
GET /catalog/{tenant}/catalogs/{catalogId} HTTP/1.1
Host: api.emporix.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "id": "text",
  "name": {
    "0": "t",
    "1": "e",
    "2": "x",
    "3": "t"
  },
  "description": {
    "0": "t",
    "1": "e",
    "2": "x",
    "3": "t"
  },
  "status": null,
  "visibility": {
    "visible": false,
    "from": "text",
    "to": "text"
  },
  "publishedSites": [
    "text"
  ],
  "metadata": {
    "version": 1,
    "updatedAt": "2025-07-12T08:14:10.889Z",
    "createdAt": "2025-07-12T08:14:10.889Z"
  },
  "categoryIds": [
    "text"
  ]
}

Was this helpful?