List Live Collection Items

List all published items in a collection. <Tip title="Serve data with the Content Delivery API"> Serving data to applications in real-time? Use the Content Delivery API at `api-cdn.webflow.com` for better performance. The CDN-backed endpoint is optimized for high-volume reads, while the Data API is designed for writes and management operations. </Tip> <Note> This endpoint supports: - Custom `filter[...]` queries support up to 10 filter terms and 2 text-search terms per request. - Custom `sort[...]` queries support up to 3 sort fields per request. </Note> Required scope | `CMS:read`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

collection_idstringRequiredformat: "objectid"
Unique identifier for a Collection

Query parameters

cmsLocaleIdstringOptional

Unique identifier for a CMS Locale. This UID is different from the Site locale identifier and is listed as cmsLocaleId in the Sites response. To query multiple locales, input a comma separated string.

offsetintegerOptional
Offset used for pagination if the results have more than limit records
limitintegerOptional

Maximum number of records to be returned (max limit: 100)

namestringOptional

Filter by the exact name of the item(s)

slugstringOptional
Filter by the exact slug of the item
createdOnobjectOptional

Filter by the creation date of the item(s)

lastPublishedobjectOptional

Filter by the last published date of the item(s)

lastUpdatedobjectOptional

Filter by the last updated date of the item(s)

filtermap from strings to objectsOptional
Filter collection items by custom field values. Use bracket notation: `filter[<fieldSlug>][<operator>]=<value>`. Example: `filter[price][gte]=10&filter[price][lte]=100&filter[name][contains]=shirt`. Filters are combined with AND. You can combine custom field filters with top-level filters such as `name`, `slug`, `createdOn`, `lastPublished`, and `lastUpdated`. OR logic and nested filter groups are not supported on GET requests. More filter terms can increase request latency. Supported operators by field type: | Field type | Supported operators | | --- | --- | | `id` | `eq`, `ne`, `in`, `nin` | | `PlainText` | `eq`, `ne`, `in`, `nin`, `contains`, `ncontains`, `exists` | | `Number` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `exists` | | `Switch` | `eq`, `ne`, `in`, `nin`, `exists` | | `DateTime` | `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `nin`, `exists` | | `Email`, `Phone`, `Link` | `eq`, `ne`, `in`, `nin`, `contains`, `ncontains`, `exists` | | `Color` | `eq`, `ne`, `in`, `nin`, `exists` | | `Reference` | `eq`, `ne`, `in`, `nin`, `exists` | | `Option` | `eq`, `ne`, `in`, `nin` | | `RichText`, `Image`, `MultiImage`, `VideoLink`, `MultiReference` | `exists` | `contains` and `ncontains` are case-insensitive. `ncontains` also matches items where the field is empty or not set. `exists=true` matches items where the field has a value. `exists=false` matches items where the field is missing or null. For `Switch` fields, `false` is still a set value. Value formats: | Field type | Value format | | --- | --- | | `Number` | A valid number, such as `10` or `12.5` | | `Switch` | `true` or `false` | | `DateTime` | ISO 8601 date-time string | | `id`, `Reference` | 24-character item ID | | `Option` | Option ID | | `in`, `nin` | Comma-separated list, up to 100 values | Invalid fields, invalid values, and operators that do not apply to a field type return a `400 BadArgument` response.
sortByenumOptional
Sort results by the provided value
Allowed values:
sortOrderenumOptional
Sorts the results by asc or desc
Allowed values:
sortmap from strings to enumsOptional
Sort collection items by custom fields using bracket notation: `sort[<fieldSlug>]=<asc|desc>`. - Example: `sort[price]=desc` - Multiple sort fields are applied in query-string order. When `sort[...]` is provided, it takes precedence over `sortBy` and `sortOrder`. - Sortable field types: `PlainText`, `Email`, `Phone`, `Number`, `DateTime`, and `Switch`. - Unknown fields, invalid sort directions, and non-sortable field types return a `400 BadArgument` response.
Allowed values:

Response

Request was successful
itemslist of objects
List of Items within the collection
paginationobject

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error