Skip to navigation
CMSCollection ItemsStaged Items

List Items

Components in Rich Text

Rich Text field values can contain Webflow component instances as <wf-component> markup — see Components in Rich Text for the markup grammar, how to find component and property IDs, and the write constraints.

List of all Items within a Collection.

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

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 typeSupported operators
ideq, ne, in, nin
PlainTexteq, ne, in, nin, contains, ncontains, exists
Numbereq, ne, gt, gte, lt, lte, in, nin, exists
Switcheq, ne, in, nin, exists
DateTimeeq, ne, gt, gte, lt, lte, in, nin, exists
Email, Phone, Linkeq, ne, in, nin, contains, ncontains, exists
Coloreq, ne, in, nin, exists
Referenceeq, ne, in, nin, exists
Optioneq, ne, in, nin
RichText, Image, MultiImage, VideoLink, MultiReferenceexists

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 typeValue format
NumberA valid number, such as 10 or 12.5
Switchtrue or false
DateTimeISO 8601 date-time string
id, Reference24-character item ID
OptionOption ID
in, ninComma-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:
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.

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