CategorySearchInput

Search and filter criteria for category queries.

Provides comprehensive filtering, sorting, and pagination options for category searches. Supports text search, hierarchical filtering, visibility control, and multilingual content.

input CategorySearchInput {
  name: String
  language: String
  slug: [String!]
  categoryId: [Int!]
  parentCategoryId: [Int!]
  hidden: YesNo
  page: Int
  offset: Int
  sortField: CategorySortableFields
  sortOrder: SortOrder!
}

Fields

CategorySearchInput.name ● String scalar

Search categories by name.

Performs full text matching against category names in the specified or default language. Case-sensitive search that matches the entire category name.

CategorySearchInput.language ● String scalar

Language code for localized search.

The language to use when searching categories by name or slug. When omitted, the category's default language is used. Must be a valid ISO 639-1 language code (2 characters).

CategorySearchInput.slug ● [String!] list scalar

Search categories by URL slugs.

Find categories by one or more SEO-friendly URL slugs. Matches exact slug values in the specified or default language.

CategorySearchInput.categoryId ● [Int!] list scalar

Filter categories by specific identifiers.

Find categories by one or more category IDs. Useful for retrieving specific categories or checking existence.

CategorySearchInput.parentCategoryId ● [Int!] list scalar

Filter categories by parent relationships.

Find categories that belong to one or more parent categories. Useful for retrieving subcategories of specific parent categories.

CategorySearchInput.hidden ● YesNo enum

Filter categories by visibility status.

Find categories by their hidden status. Y = hidden categories, N = visible categories. When omitted, returns both hidden and visible categories.

CategorySearchInput.page ● Int scalar

Page number for pagination.

The page number to return in paginated results. Must be a positive integer. Defaults to 1.

CategorySearchInput.offset ● Int scalar

Number of categories per page.

The amount of categories to return per page. Must be a positive integer. Defaults to 12.

CategorySearchInput.sortField ● CategorySortableFields enum

Field to sort categories by.

Available sortable fields: [name, dateCreated, entityDateChanged]. When omitted, results are returned in default order.

CategorySearchInput.sortOrder ● SortOrder! non-null enum

Sort order for results.

Determines the sorting direction for the specified sort field. ASC = ascending order, DESC = descending order. Defaults to ascending order.

Member Of

categories query