List content items

Request

Returns a filtered list of content items. The list will include the content item specified by the contentItemId parameter and any content items below it in the hierarchy. If the content item has no children, it will just return the content item itself. The results can be filtered further by using the search parameter to filter the content items by name or other indexed fields, or the id parameter to fetch content items (up to 50) with matching ids. The search and id are mutually exclusive.

Security

Bearer

Query

environmentIdstring

The environment identifier. Defaults to "main". Currently only "main" is supported.

Example:environmentId=main

searchstring

An optional search string used to filter content items by name or other indexed fields. Mutually exclusive with id.

Example:search=page

contentItemIdstringrequired

The identifier of the content item used to filter query results. If the content item has no children, the results will include just the content item itself. Otherwise, the results will include the content items and any others below it in the content hierarchy.

Example:contentItemId=497f6eca-6276-4993-bfeb-53cbbbba6f08

languagestring

The language of the content items

Example:language=en

pageSizeinteger, (int32)

The maximum number of items to return in a single page.

Example:pageSize=10

idArray of strings, (uuid)

An optional list of known content item identifiers, e.g. id=id1&id=id2&id=id3. Limited to 50 ids per request (extras truncated). Mutually exclusive with search.

Headers

x-sc-continuationstring

An optional opaque token returned from a previous call used to fetch the next page of results.

Example:MXx8fDEwMA==

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/authoring/api/v1/content-items?environmentId=main&search=page&contentItemId=497f6eca-6276-4993-bfeb-53cbbbba6f08&language=en&pageSize=10&id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'x-sc-continuation: MXx8fDEwMA=='

Responses

Successful operation. Returns an empty result set if no content items match the query.

Bodyapplication/json

countinteger, (int32)

Total number of matching content items.

Example:10

nextstring or null

Continuation token.

Example:"token-from-previous-response"

resultsArray of objects or null(DatasourceSearchItem)

List of content item search results.

Response

{
  "count": 10,
  "next": "token-from-previous-response",
  "results": [
    { … }
  ]
}