> ## Documentation Index
> Fetch the complete documentation index at: https://developer.z-api.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Community metadata

> Returns community metadata with name, description and groups

## Overview

This method returns the community metadata, such as name, description and linked groups.

***

## Attributes

### Header

<ParamField path="instanceId" type="string" required>
  Your instance ID. Available in the Z-API panel under **Instances**.
</ParamField>

<ParamField path="token" type="string" required>
  Your Z-API instance token.
</ParamField>

### Path

<ParamField path="communityId" type="string" required>
  Community ID
</ParamField>

***

## Response

### 200

<ResponseField name="name" type="string">
  Community name
</ResponseField>

<ResponseField name="id" type="string">
  Community ID
</ResponseField>

<ResponseField name="description" type="string">
  Community description
</ResponseField>

<ResponseField name="subGroups" type="array">
  Groups linked to the community

  <Expandable title="Properties">
    <ResponseField name="name" type="string">
      Group name
    </ResponseField>

    <ResponseField name="phone" type="string">
      Group ID/Phone
    </ResponseField>

    <ResponseField name="isGroupAnnouncement" type="boolean">
      Whether it is the announcement group
    </ResponseField>
  </Expandable>
</ResponseField>

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "name": "My first Community",
  "id": "98372465382764532938",
  "description": "A community description",
  "subGroups": [
    {
      "name": "My first Community",
      "phone": "342532456234453-group",
      "isGroupAnnouncement": true
    },
    {
      "name": "Another group",
      "phone": "1203634230225498-group",
      "isGroupAnnouncement": false
    }
  ]
}
```

### 405

Make sure you are correctly sending the method specification, that is, verify that you sent POST or GET as specified at the beginning of this topic.

### 415

If you receive a 415 error, make sure to add the "Content-Type" header to your request, which in most cases is "application/json".
