List Live Collection Items | Webflow Developer Documentation

Components in Rich Text (beta)

Rich Text field values may contain Webflow component instances as <wf-component> markup. On read they appear inline in the field’s HTML; on write, the same markup creates or updates the instance.

Scalar props are prop-<propId>="…" attributes on the <wf-component>. Text and rich-text props are nested <wf-prop type="text|richtext">…</wf-prop> children.

A write is rejected with a 400 if a component can’t be resolved, isn’t allowed in Rich Text (e.g. it contains a Slot or Collection List), includes an unknown prop, or creates a new instance in a secondary locale.

component-id and each prop-<propId> are specific to your site’s component definition — obtain them by listing your site’s components (GET /v2/sites/{site_id}/components, plus /components/{component_id}/properties for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit data-w-id when creating an instance (the server assigns it); keep it when updating one.

List all published items in a collection.

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.

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.

Required scope | CMS:read

<Note title="Components in Rich Text (beta)"> Rich Text field values may contain Webflow component instances as `<wf-component>` markup. On read they appear inline in the field's HTML; on write, the same markup creates or updates the instance. Scalar props are `prop-<propId>="…"` attributes on the `<wf-component>`. Text and rich-text props are nested `<wf-prop type="text|richtext">…</wf-prop>` children. A write is rejected with a `400` if a component can't be resolved, isn't allowed in Rich Text (e.g. it contains a Slot or Collection List), includes an unknown prop, or creates a new instance in a secondary locale. `component-id` and each `prop-<propId>` are specific to your site's component definition — obtain them by listing your site's components (`GET /v2/sites/{site_id}/components`, plus `/components/{component_id}/properties` for prop IDs) or by reading an item that already contains the component and reusing the returned markup. Omit `data-w-id` when creating an instance (the server assigns it); keep it when updating one. </Note> 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.

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.

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:

translatablestringOptional

Unique identifier for the secondary Locale you’re translating into. Returns only content that hasn’t been excluded from translation for that locale.

This is independent of localeId, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale’s content and set translatable to the locale you’re translating into:

?localeId={primary locale id}&translatable={target locale id}

Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don’t affect this parameter’s response.

Omitting translatable returns the same response as if this parameter didn’t exist. The value must be the id of one of the site’s secondary locales — the primary locale id, or any other value, returns a 400 error. Requires translation exclusions to be enabled for the site; if they aren’t, the request returns a 403 error.

Learn more about localization.

Unique identifier for the secondary Locale you're translating **into**. Returns only content that hasn't been excluded from translation for that locale. This is independent of `localeId`, which selects which version of the content is returned. To fetch the source text to translate, request the primary locale's content and set `translatable` to the locale you're translating into: `?localeId={primary locale id}&translatable={target locale id}` Only exclusion rules scoped to manual translation are respected — rules scoped only to automatic translation don't affect this parameter's response. Omitting `translatable` returns the same response as if this parameter didn't exist. The value must be the id of one of the site's secondary locales — the primary locale id, or any other value, returns a `400` error. Requires translation exclusions to be enabled for the site; if they aren't, the request returns a `403` error. [Learn more about localization.](/data/v2.0.0/docs/working-with-localization)

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

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.

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.

$	curl -G https://api.webflow.com/v2/collections/580e63fc8c9a982ac9b8b745/items/live \
>	-H "Authorization: Bearer <token>" \
>	-d offset=0 \
>	-d limit=100 \
>	-d translatable=65427cf400e02b306eaa04a0

1	{
2	"items": [
3	{
4	"id": "62b720ef280c7a7a3be8cabe",
5	"lastPublished": "2022-06-30T13:35:20.878Z",
6	"lastUpdated": "2022-06-25T14:51:27.809Z",
7	"createdOn": "2022-06-25T14:51:27.809Z",
8	"fieldData": {
9	"name": "Senior Data Analyst",
10	"slug": "senior-data-analyst",
11	"url": "https://boards.greenhouse.io/webflow/jobs/26567701",
12	"department": "Data"
13	},
14	"cmsLocaleId": "66f6e966c9e1dc700a857ca3",
15	"isArchived": false,
16	"isDraft": false
17	},
18	{
19	"id": "62c880ef281c7b7b4cf9dabc",
20	"lastPublished": "2023-04-15T10:25:18.123Z",
21	"lastUpdated": "2023-04-10T11:45:30.567Z",
22	"createdOn": "2023-04-10T11:45:30.567Z",
23	"fieldData": {
24	"name": "Product Manager",
25	"slug": "product-manager",
26	"url": "https://boards.greenhouse.io/webflow/jobs/31234567",
27	"department": "Product"
28	},
29	"cmsLocaleId": "66f6e966c9e1dc700a857ca3",
30	"isArchived": false,
31	"isDraft": false
32	}
33	],
34	"pagination": {
35	"limit": 25,
36	"offset": 0,
37	"total": 2
38	}
39	}