Skip to main content

categories

Search the catalogue for categories matching the supplied criteria.

Filters can target identifiers, external sources, parents, hierarchy depth and creation or modification date ranges. Results are paginated and may be sorted by any of the supported fields. Hidden categories can be filtered in or out for catalog-facing surfaces.

Possible errors:

  • CATEGORY_FIND_ERROR: The supplied criteria could not be applied to the catalogue.
  • SCHEMA_VALIDATION: One or more search criteria failed validation.

AUTH: Role=[product.OWNER,product.EDITOR,product.VIEWER]

categories(
  input: CategorySearchInput
  filter: CategorySearchInput
): CategoryResponse!

Arguments​

categories.input ● CategorySearchInput input​

Search criteria, pagination and sorting for the category search.

categories.filter ● CategorySearchInput input​

Deprecated alias for input. Will be removed in the next major version.

Type​

CategoryResponse object​

Paginated response containing categories