Interfaces
Interface: CollectionListOptions
Options for listing collection items
Options for listing collection items
Extends
Properties
| Property | Type | Description | Inherited from |
|---|---|---|---|
filters? | FilterCondition | Advanced filters for additional filtering | - |
limit? | number | Number of items per page | - |
media? | MediaMode | - | MediaOption.media |
page? | number | Page number for pagination (1-indexed) | - |
preview? | boolean | - | PreviewOption.preview |
refTypes? | boolean | - | RefTypesOption.refTypes |
sort? | string | Sort order using the -field prefix convention: prefix with - for descending, no prefix for ascending. Comma-separate multiple fields for multi-field sort. Examples: - sort: '-publishedAt' — newest first (descending) - sort: 'name' — alphabetical ascending - sort: '_sortOrder' — manual authored order, ascending (lowest sort_order first) - sort: '-_sortOrder' — manual authored order, reversed (highest sort_order first) - sort: '-publishedAt,name' — multi-field: newest first, then name A–Z NOTE: collection results are an unordered set unless you sort — the default is publishedAt descending, which is NOT the authored _sortOrder order. Prefer selecting a specific item by a content field (e.g. filters: [{ field: 'name', operator: 'eq', value: 'Header Navigation' }]) over positional access like data[0]. | - |
status? | "published" | "draft" | Filter by status | - |