ModelCategoryEntryListParams

Request parameters for listing category entries.

Used by ModelCategoryInstance.entries.

Hierarchy

BaseRequestParameters
QueryableRequestParameters
- ModelCategoryEntryListParams

Index

Properties

except
fields
limit
order
page
query
query:word

Properties

optionalexcept

except?: number

If defined, removes the given item from the list. Useful to create “related posts” lists.

Note: this field only accepts IDs, and not slugs. Only one ID is allowed.

optionalfields

fields?: string

A comma-separated list of fields to look up on when searching using query or query:word. If undefined, all text fields will be searched on, including Visual Editor fields. Search is not case-sensitive.

For instance, to limit search on the “content” and “summary” fields of a model, pass 'content,summary'.

optionallimit

limit?: number

The limit of items per page.

optionalorder

Define how entries will be ordered. Check this field type to see the allowed options.

optionalpage

page?: number

The page requested.

optionalquery

query?: string

A search query string.

For instance, searching for “out” will match both “check out!” and “about us”. Search is not case-sensitive.

optionalquery:word

query:word?: string

A search query string that matches a specific word within boundaries. Search is not case-sensitive.

For instance, searching for “phone” will match “This is my phone!” but won’t match “This is my telephone!”.