> ## 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.

# Channel metadata

> Returns the channel metadata with all information

## Overview

This method returns the channel metadata with all the channel information and its view settings.

***

## 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="newsletterId" type="string" required>
  Channel ID
</ParamField>

***

## Response

### 200

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

<ResponseField name="creationTime" type="number">
  Channel creation timestamp
</ResponseField>

<ResponseField name="state" type="string">
  Channel state (ACTIVE or NON\_EXISTING)
</ResponseField>

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

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

<ResponseField name="subscribersCount" type="string">
  Number of channel subscribers
</ResponseField>

<ResponseField name="inviteLink" type="string">
  Channel invite link
</ResponseField>

<ResponseField name="verification" type="string">
  Verification status (VERIFIED or UNVERIFIED)
</ResponseField>

<ResponseField name="picture" type="string">
  Channel image URL
</ResponseField>

<ResponseField name="preview" type="string">
  Channel preview image URL
</ResponseField>

<ResponseField name="viewMetadata" type="object">
  Channel view information

  <Expandable title="Properties">
    <ResponseField name="mute" type="string">
      Channel mute status (ON or OFF)
    </ResponseField>

    <ResponseField name="role" type="string">
      User role in the channel (OWNER or SUBSCRIBER)
    </ResponseField>
  </Expandable>
</ResponseField>

```json theme={"theme":{"light":"github-light","dark":"poimandres"}}
{
  "id": "999999999999999999@newsletter",
  "creationTime": 1695124988,
  "state": "ACTIVE",
  "name": "Channel name",
  "description": "Description",
  "subscribersCount": "150",
  "inviteLink": "https://whatsapp.com/channel/...",
  "verification": "VERIFIED",
  "picture": "https://...",
  "preview": "https://...",
  "viewMetadata": {
    "mute": "OFF",
    "role": "OWNER"
  }
}
```

<Info>
  The channel ID must always contain the **@newsletter** suffix, as this is the standard used by WhatsApp.
</Info>

### 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".