List component summaries

Request

Retrieves a lightweight list of components containing only id, name, displayName, systemName and modelId for all sites or specific sites. Use this endpoint for any scenario that does not require full component details.

Security

Bearer

Query

siteIdstring

The site identifier.

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

environmentIdstring

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

Example:environmentId=main

curl -i -X GET \
  'https://edge-platform.sitecorecloud.io/authoring/api/v1/components/summaries?siteId=497f6eca-6276-4993-bfeb-53cbbbba6f08&environmentId=main' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful operation

Bodyapplication/json

Array [

idstring or null

The identifier of the component.

Example:"2492bac4-da07-4c86-87f0-9873d40e2276"

namestring or null

The name of the component.

Example:"Hero Banner"

displayNamestring or null

The component display name.

Example:"Banner"

systemNamestring or null

The component system name.

Example:"HeroBanner"

modelIdstring or null

The identifier of the content type.

Example:"3f2504e0-4f89-11d3-9a0c-0305e82c3301"

]

Response

[
  {
    "id": "2492bac4-da07-4c86-87f0-9873d40e2276",
    "name": "Hero Banner",
    "displayName": "Banner",
    "systemName": "HeroBanner",
    "modelId": "3f2504e0-4f89-11d3-9a0c-0305e82c3301"
  }
]