externalListEntriesParams

Request parameters for listing entries.

Used by EntrySelector.list.

Hierarchy

BaseRequestParameters
QueryableRequestParameters
- ListEntriesParams

Index

Properties

categories
data
except
fields
limit
order
page
published_after
published_before
query
query:word

Properties

externaloptionalcategories

categories?: string

A comma-separated list of categories. Only entries in these categories will be returned. If undefined, all entries in the model will be listed.

For instance, to show only entries in the “news” and “articles” categories, pass 'news,category'.

externaloptionaldata

data?: boolean

When false, the returned entries won’t have any data attached to them, even if their Model have listable fields. Defaults to true.

externaloptionalexcept

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.

externaloptionalfields

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'.

externaloptionallimit

limit?: number

The limit of items per page.

externaloptionalorder

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

externaloptionalpage

page?: number

The page requested.

externaloptionalpublished_after

published_after?: string

When given, return entries published after the given date. Should be an ISO 8601 date string.

Tip: in JavaScript, you can get an ISO 8601 date string by using Date.toISOString().

externaloptionalpublished_before

published_before?: string

When given, return entries published before the given date. Should be an ISO 8601 date string.

Tip: in JavaScript, you can get an ISO 8601 date string by using Date.toISOString().

externaloptionalquery

query?: string

A search query string.

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

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