ListCollectionsParams

Request parameters for listing collections.

Used by CollectionSelector.list.

Hierarchy

• BaseRequestParameters
  • ListCollectionsParams

Index

Properties

• limit
• order
• page
• query

Properties

optionallimit

limit?: number

Inherited from BaseRequestParameters.limit

The limit of items per page.

optionalorder

order?: title:asc | title:desc | item_count:asc | item_count:desc

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

optionalpage

page?: number

Inherited from BaseRequestParameters.page

The page requested.

optionalquery

query?: string

Inherited from BaseRequestParameters.query

A search query string.

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