CMSCollection ItemsStaged Items

List Items

List of all Items within a Collection.

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)

sortByenumOptional
Sort results by the provided value
Allowed values:
sortOrderenumOptional
Sorts the results by asc or desc
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.](/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