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

# Listar canais

> Lista canais nos quais a conta está inscrita (seguindo ou admin / dono)

**Auth:** `TokenAccount` ou `TokenInstance` • **Rate-limit:** `Global` (100/min) • **Idempotente:** sim (read-only)

## Descrição

Retorna **todos** os canais aos quais a conta está inscrita, canais que ela segue **e** canais dos quais é admin / dono. Sem paginação: a lista vem completa em uma única resposta.

## Exemplos

### Listar

Retorna em uma única resposta todos os canais que a conta segue ou administra. Sem filtros nem paginação, o cliente recebe a lista completa em `newsletters[]` com metadados de cada canal.

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

## Resposta de sucesso

A resposta traz `newsletters[]` com cada canal seguido ou administrado pela conta e `meta.total` com a contagem (igual a `newsletters.length`). Cada item segue o shape `NewsletterChannel` (mesmo de [`/info`](/pt/api/newsletter/info)). Quando a conta não segue nenhum canal, o array vem vazio e `meta.total = 0`.

```json 200 OK theme={null}
{
  "success": true,
  "message": "2 newsletter(s) found",
  "newsletters": [
    {
      "jid": "120363422585881117@newsletter",
      "state": "active",
      "name": "Notícias",
      "description": "Atualizações diárias",
      "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://exemplo.com/tech.jpg"
    }
  ],
  "meta": { "total": 2 }
}
```

## Parâmetros de rota

<ParamField path="instance" type="string" required>
  Nome da instância.
</ParamField>

## Headers

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

## Notas

<Note>
  * A lista mistura canais **seguidos** + **administrados**. Não há flag distintiva, para diferenciar, use [`GET /info`](/pt/api/newsletter/info) para inspecionar role.
  * Canais `suspended` / `geosuspended` aparecem na lista, filtre no cliente se quiser apenas operacionais.
  * `inviteLink` e `pictureUrl` são `omitempty`, canais que você só segue normalmente não expõem o link de convite.
  * Sem paginação: contas com 100+ canais podem ter respostas grandes.
</Note>

## Erros

| HTTP | Mensagem                                                                                        |
| ---- | ----------------------------------------------------------------------------------------------- |
| 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" }
}
```