---
title: "Get all components for a component group"
method: GET
path: "/channels/{channel_id}/component_groups/{group_name}/components"
tags: ["Channel Component Operations"]
---

# Get all components for a component group

`GET /channels/{channel_id}/component_groups/{group_name}/components`

## Path parameters

- `channel_id` string, required
- `group_name` string, required

## Response `200`

OK

- ComponentDefinition[]
  - `id` string, required — identifier of this component definition: {group}/{name}
  - `extends` string, required — {group}/{name} id of the component definition this definition extends from
  - `hidden` boolean — indicator if this component definition is configurable in the ChannelManager UI
  - `system` boolean — indicator if this a protected (system) component definition; if true, implies hidden is true
  - `xtype` string — frontend layout type
  - `ctype` string — frontend component type
  - `contentType` string — contentType for cases where the component should also create content: when putting, the contentType must be an existing document compound type, otherwise the request is not executed. The value for the contentType may optionally include the namespace prefix; this is only required in case the type is in a namespace other than 'brxsaas', eg mynamespace:titleandtext
  - `label` string — default display name of this component definition in the ChannelManager UI
  - `icon` string — base64 representation of the icon for this component definition in the ChannelManager UI
  - `parameters` Parameter[] — custom (residual) or customized (overlaying) parameters for this component definition. Parameters with config type 'imagesetpath' are not allowed
    - `name` string, required
    - `valueType` 'string' | 'calendar' | 'boolean' | 'integer' | 'number', required
    - `required` boolean
    - `hidden` boolean
    - `overlay` boolean
    - `defaultValue` object
    - `displayName` string
    - `system` boolean — System readonly parameter
    - `config` union — Field Config, or null if this parameter is neither of the types below. The config type 'imagesetpath' cannot be used with component parameters but only with channel parameters
      - object — This config type is used when a document picker is needed in the CMS UI. See [Define Configuration Parameters for Components](https://documentation.bloomreach.com/content/docs/define-configuration-parameters-for-components)
        - `type` 'contentpath' | 'dropdown' | 'imagesetpath', required — the type of this config field
        - `pickerConfiguration` string
        - `pickerInitialPath` string
        - `pickerRememberLastVisited` boolean
        - `pickerSelectableNodeTypes` string[]
        - `relative` boolean
        - `pickerRootPath` string
        - `enableUpload` boolean
      - object — This config type is used when a dropdown list is needed in the CMS UI. See [Define Configuration Parameters for Components](https://documentation.bloomreach.com/content/docs/define-configuration-parameters-for-components)
        - `type` 'contentpath' | 'dropdown' | 'imagesetpath', required — the type of this config field
        - `value` string[], required
        - `structuredValues` KeyLabel[] — Expects an array of key-label values.
          - `key` string, required — key validation of the field. Expects a string value
          - `label` string, required — label validation of the field. Expects a string value
        - `valueListProvider` string
        - `sourceId` string, required
      - object — This config type is used when an image picker is needed in the CMS UI
        - `type` 'contentpath' | 'dropdown' | 'imagesetpath', required — the type of this config field
        - `pickerConfiguration` string
        - `pickerInitialPath` string
        - `pickerRememberLastVisited` boolean
        - `pickerSelectableNodeTypes` string[]
        - `previewVariant` string
        - `enableUpload` boolean
  - `fieldGroups` FieldGroup[] — field groups
    - `name` string — Field Group Name
    - `displayName` string — Field Group Display Name
    - `parameters` string[] — Field Group Parameters

## Other responses

- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.dev/bloomreach/apis/documents-delivery-api-2-0.md) · [All operations](https://skmtc.dev/bloomreach/apis/documents-delivery-api-2-0/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bloomreach/documents-delivery-api-2-0/revisions/87bfc06578c2/schema)