Sitecore API catalog/Components API/
/
List components

List components

Request

Retrieves a list of components and their details for all sites or specific sites.

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?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 displayName.

Example:"Banner"
systemNamestring or null

The component system name.

Example:"HeroBanner"
descriptionstring or null

The component description.

Example:"A promo component is a content block designed to showcase promotions using a combination of text and visuals"
categoryobject(ComponentCategory)
iconstring or null

The component icon URL.

Example:"https://xmc-instance.sitecore-staging.cloud/-/icon/SXA_MDI/16x16/Promo.png"
datasourceTemplateFieldstring or null

Datasource template item path.

Example:"/sitecore/templates/Feature/Promos"
modelIdstring or null

The content type identifier.

Example:"/sitecore/templates/Feature/Promos"
renderingParametersobject or null

The component rendering parameters.

Example:
{
  "ButtonText": "Click me!"
}
settingsobject or null

The component settings.

Example:
{
  "IsRenderingsWithDynamicPlaceholders": "true",
  "RandomNumber": "10"
}
variantsArray of objects or null(ComponentVariant)

The component variants.

Example:
[
  {
    "name": "Default",
    "id": "2492bac4-da07-4c86-87f0-9873d40e2276",
    "siteId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  },
  {
    "name": "Advanced",
    "id": "2f34355e-c52d-450e-b1b9-d4e9cbe64af2",
    "siteId": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  }
]
systemobject(System)
typestring(ComponentType)

Specifies the type of a component based on its rendering template.

Enum:"Code""Hosted"
]
Response
[
  {
    "id": "2492bac4-da07-4c86-87f0-9873d40e2276",
    "name": "Hero Banner",
    "displayName": "Banner",
    "systemName": "HeroBanner",
    "description": "A promo component is a content block designed to showcase promotions using a combination of text and visuals",
    "category": { … },
    "icon": "https://xmc-instance.sitecore-staging.cloud/-/icon/SXA_MDI/16x16/Promo.png",
    "datasourceTemplateField": "/sitecore/templates/Feature/Promos",
    "modelId": "/sitecore/templates/Feature/Promos",
    "renderingParameters": { … },
    "settings": { … },
    "variants": [ … ],
    "system": { … },
    "type": "Code"
  }
]