List Collection Items

GET

List of all Items within a Collection.

Required scope | CMS:read

Path parameters

collection_idstringRequired

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.

offsetdoubleOptional

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

limitdoubleOptional

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

lastPublishedobjectOptional

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

sortByenumOptional

Sort results by the provided value

Allowed values: lastPublishednameslug
sortOrder"asc" or "desc"Optional

Sorts the results by asc or desc

Allowed values: ascdesc

Response

Request was successful

itemslist of objects

List of Items within the collection

paginationobject

Errors

Built with