---
title: "GET /thing-groups/{thingGroupName}"
method: GET
path: "/thing-groups/{thingGroupName}"
---

# GET /thing-groups/{thingGroupName}

`GET /thing-groups/{thingGroupName}`

Describe a thing group.

Requires permission to access the [DescribeThingGroup](https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions) action.

## Path parameters

- `thingGroupName` string, required

## Response `200`

Success

- DescribeThingGroupResponse
  - `thingGroupName` string — The name of the thing group.
  - `thingGroupId` string — The thing group ID.
  - `thingGroupArn` string — The thing group ARN.
  - `version` integer — The version of the thing group.
  - `thingGroupProperties` object — The thing group properties.
    - `thingGroupDescription` string — The thing group description.
    - `attributePayload` object — The thing group attributes in JSON format.
      - `attributes` object — <p>A JSON string containing up to three key-value pair in JSON format. For example:</p> <p> <code>{\"attributes\":{\"string1\":\"string2\"}}</code> </p>
      - `merge` boolean — <p>Specifies whether the list of attributes provided in the <code>AttributePayload</code> is merged with the attributes stored in the registry, instead of overwriting them.</p> <p>To remove an attribute, call <code>UpdateThing</code> with an empty attribute value.</p> <note> <p>The <code>merge</code> attribute is only valid when calling <code>UpdateThing</code> or <code>UpdateThingGroup</code>.</p> </note>
  - `thingGroupMetadata` object — Thing group metadata.
    - `parentGroupName` string — The parent thing group name.
    - `rootToParentThingGroups` GroupNameAndArn[] — The root parent thing group.
      - `groupName` string — The group name.
      - `groupArn` string — The group ARN.
    - `creationDate` string, date-time — The UNIX timestamp of when the thing group was created.
  - `indexName` string — The dynamic thing group index name.
  - `queryString` string — The dynamic thing group search query string.
  - `queryVersion` string — The dynamic thing group query version.
  - `status` 'ACTIVE' | 'BUILDING' | 'REBUILDING' — The dynamic thing group status.

## Other responses

- `480` — InvalidRequestException
- `481` — ThrottlingException
- `482` — InternalFailureException
- `483` — ResourceNotFoundException

---

[API](https://skmtc.net/aws/apis/iot.md) · [All operations](https://skmtc.net/aws/apis/iot/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/iot/versions/deef5c4b09f0/schema)