Skip to main content

Interface: ClusterCategorySearchInput

Defined in: type/ClusterCategorySearchInput.ts:7

Input object for ClusterCategorySearchInput

Properties​

categoryIds?​

optional categoryIds?: number[]

Defined in: type/ClusterCategorySearchInput.ts:32

Filter by category IDs

createdAtFrom?​

optional createdAtFrom?: string

Defined in: type/ClusterCategorySearchInput.ts:36

Start date for creation date filtering (ISO 8601 format)

createdAtTo?​

optional createdAtTo?: string

Defined in: type/ClusterCategorySearchInput.ts:38

End date for creation date filtering (ISO 8601 format)

dateCreatedFrom?​

optional dateCreatedFrom?: string

Defined in: type/ClusterCategorySearchInput.ts:44

Deprecated: use createdAtFrom instead. Start date for creation date filtering (ISO 8601 format)

dateCreatedTo?​

optional dateCreatedTo?: string

Defined in: type/ClusterCategorySearchInput.ts:46

Deprecated: use createdAtTo instead. End date for creation date filtering (ISO 8601 format)

dateModifiedFrom?​

optional dateModifiedFrom?: string

Defined in: type/ClusterCategorySearchInput.ts:48

Deprecated: use lastModifiedAtFrom instead. Start date for modification date filtering (ISO 8601 format)

dateModifiedTo?​

optional dateModifiedTo?: string

Defined in: type/ClusterCategorySearchInput.ts:50

Deprecated: use lastModifiedAtTo instead. End date for modification date filtering (ISO 8601 format)

hidden?​

optional hidden?: YesNo

Defined in: type/ClusterCategorySearchInput.ts:17

Find categories by their hidden status

language?​

optional language?: string

Defined in: type/ClusterCategorySearchInput.ts:11

The language to use when searching categories by name or slug. When omitted the categories default language is used

lastModifiedAtFrom?​

optional lastModifiedAtFrom?: string

Defined in: type/ClusterCategorySearchInput.ts:40

Start date for modification date filtering (ISO 8601 format)

lastModifiedAtTo?​

optional lastModifiedAtTo?: string

Defined in: type/ClusterCategorySearchInput.ts:42

End date for modification date filtering (ISO 8601 format)

name?​

optional name?: string

Defined in: type/ClusterCategorySearchInput.ts:9

Find categories by name

offset?​

optional offset?: number

Defined in: type/ClusterCategorySearchInput.ts:21

The amount of categories return per page

page?​

optional page?: number

Defined in: type/ClusterCategorySearchInput.ts:19

The page number to return

parentCategoryId?​

optional parentCategoryId?: number[]

Defined in: type/ClusterCategorySearchInput.ts:15

Find categories by one or more parentCategoryIds

parentCategoryIds?​

optional parentCategoryIds?: number[]

Defined in: type/ClusterCategorySearchInput.ts:30

Filter by parent category IDs

slug?​

optional slug?: string[]

Defined in: type/ClusterCategorySearchInput.ts:13

Find categories by one or more slugs

slugs?​

optional slugs?: string[]

Defined in: type/ClusterCategorySearchInput.ts:28

Search by category slugs

sortField?​

optional sortField?: CategorySortableFields

Defined in: type/ClusterCategorySearchInput.ts:23

Available sortable fields One of: [name, dateCreated, entityDateChanged]

sortOrder​

sortOrder: SortOrder

Defined in: type/ClusterCategorySearchInput.ts:25

Sort ordering ['desc' or 'asc']

source?​

optional source?: string

Defined in: type/ClusterCategorySearchInput.ts:52

Source system name (must be used with sourceIds)

sourceIds?​

optional sourceIds?: string[]

Defined in: type/ClusterCategorySearchInput.ts:54

Source IDs to filter by (must be used with source)

uuids?​

optional uuids?: string[]

Defined in: type/ClusterCategorySearchInput.ts:34

Filter by category UUIDs