> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ryzeapi.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# List channels

> List channels the account is subscribed to (following or admin / owner)

**Auth:** `TokenAccount` or `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotent:** yes (read-only)

## Description

Returns **all** channels the account is subscribed to, channels it follows **and** channels it is admin / owner of. No pagination: the list comes complete in a single response.

## Examples

### List

Returns every channel the account follows or administers in a single response. With no filters or pagination, the client receives the full list in `newsletters[]` with metadata for each channel.

<CodeGroup>
  ```bash cURL theme={null}
  curl -X GET "https://ryzeapi.cloud/api/newsletter/list/$Instance_Name" \
    -H "token: $Token_Instance"
  ```

  ```javascript JavaScript theme={null}
  await fetch(`https://ryzeapi.cloud/api/newsletter/list/${process.env.Instance_Name}`, {
    method: "GET",
    headers: {
      "token": process.env.Token_Instance
    }
  });
  ```

  ```python Python theme={null}
  import os, requests

  requests.get(
      f"https://ryzeapi.cloud/api/newsletter/list/{os.environ['Instance_Name']}",
      headers={
          "token": os.environ["Token_Instance"]
      }
  )
  ```

  ```go Go theme={null}
  package main

  import (
      "net/http"
      "os"
  )

  func main() {
      req, _ := http.NewRequest("GET", "https://ryzeapi.cloud/api/newsletter/list/"+os.Getenv("Instance_Name"), nil)
      req.Header.Set("token", os.Getenv("Token_Instance"))
      http.DefaultClient.Do(req)
  }
  ```
</CodeGroup>

## Success response

The response carries `newsletters[]` with each channel followed or administered by the account, plus `meta.total` with the count (equal to `newsletters.length`). Each item follows the `NewsletterChannel` shape (same as [`/info`](/en/api/newsletter/info)). When the account follows no channels, the array is empty and `meta.total = 0`.

```json 200 OK theme={null}
{
  "success": true,
  "message": "2 newsletter(s) found",
  "newsletters": [
    {
      "jid": "120363422585881117@newsletter",
      "state": "active",
      "name": "News",
      "description": "Daily updates",
      "inviteLink": "https://whatsapp.com/channel/120363422585881117",
      "subscriberCount": 150,
      "pictureUrl": null
    },
    {
      "jid": "120363499999999999@newsletter",
      "state": "active",
      "name": "Tech News",
      "description": "Latest tech updates",
      "subscriberCount": 500,
      "pictureUrl": "https://example.com/tech.jpg"
    }
  ],
  "meta": { "total": 2 }
}
```

## Path parameters

<ParamField path="instance" type="string" required>
  Instance name.
</ParamField>

## Headers

<ParamField header="token" type="string" required>
  `TokenAccount` or `TokenInstance`.
</ParamField>

## Notes

<Note>
  * The list mixes **followed** + **administered** channels. There is no distinguishing flag, to differentiate, use [`GET /info`](/en/api/newsletter/info) to inspect the role.
  * `suspended` / `geosuspended` channels appear in the list, filter on the client if you only want operational ones.
  * `inviteLink` and `pictureUrl` are `omitempty`, channels you only follow normally do not expose the invite link.
  * No pagination: accounts with 100+ channels can have large responses.
</Note>

## Errors

| HTTP | Message                                                                                         |
| ---- | ----------------------------------------------------------------------------------------------- |
| 400  | `Instance is not connected to WhatsApp`                                                         |
| 404  | `Instance not found`                                                                            |
| 500  | `failed to get newsletters: <reason>`                                                           |
| 501  | `WhatsApp client does not support listing newsletters (GetSubscribedNewsletters not available)` |

Envelope:

```json theme={null}
{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}
```