QueryableRequestParameters

Request parameters used by most SDK methods that support advanced querying.

Hierarchy

• QueryableRequestParameters
  • ListCollectionItemsParams
  • ModelCategoryEntryListParams
  • ListEntriesParams

Index

Properties

• except
• fields
• 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'.

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!”.