Skip to main content
GET
/
api
/
newsletter
/
list
/
:instance
List channels
curl --request GET \
  --url https://api.example.com/api/newsletter/list/:instance \
  --header 'token: <token>'

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.

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. 
curl -X GET "https://ryzeapi.cloud/api/newsletter/list/$Instance_Name" \
  -H "token: $Token_Instance"

​
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). When the account follows no channels, the array is empty and meta.total = 0.
200 OK
{
  "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

​
instance
string
required
Instance name.

​
Headers

​
token
string
required
TokenAccount or TokenInstance.

​
Notes

  • The list mixes followed + administered channels. There is no distinguishing flag, to differentiate, use GET /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.

​
Errors

HTTPMessage
400Instance is not connected to WhatsApp
404Instance not found
500failed to get newsletters: <reason>
501WhatsApp client does not support listing newsletters (GetSubscribedNewsletters not available)
Envelope: 
{
  "success": false,
  "error": { "message": "Instance is not connected to WhatsApp" }
}