---
title: "Read the metadata of a component group."
method: GET
path: "/component-registry/component-groups/{componentGroupReference}"
tags: ["Component Registry"]
---

# Read the metadata of a component group.

`GET /component-registry/component-groups/{componentGroupReference}`

## Path parameters

- `componentGroupReference` string, required

## Query parameters

- `language` string

## Response `200`

Ok

- ComponentRegistryComponentGroupMetadata — Data for fetching information about component groups. Contains all properties which are accessible by clients.
  - `componentGroupReference` string — Reference to a component group. Components are organized into a group hierarchy which serves as a qualification mechanism to avoid name collisions and also to group components semantically. It is expressed as a string where the levels are separated with a dot (`.`).
  - `description` string
  - `hasChildren` boolean
  - `multiLanguageDescription` object, nullable
  - `multiLanguageName` object, nullable
  - `name` string
  - `state` 'ACTIVE' | 'ARCHIVED' — Possible states of a component group.

---

[API](https://skmtc.net/simscale/apis/simscale-api.md) · [All operations](https://skmtc.net/simscale/apis/simscale-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/simscale/simscale-api/revisions/53223abaceb7/schema)