Sign in

v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
channel

search channels

Search for channels

post/instances/{id}/client/action/search-channels

Path parameters

idinteger required

Instance ID

Request body

countryCodesstring[]

Optional array of ISO 3166-1 alpha-2 country codes to filter channels

searchTextstring

Optional text to search for in channel names/descriptions

view'RECOMMENDED' | 'TRENDING' | 'POPULAR' | 'NEW'

View type for results filtering

limitinteger

Maximum number of results to return

skipSubscribedNewslettersboolean

Whether to skip already subscribed newsletters in results

Example request

{
  "countryCodes": [
    "US",
    "GB"
  ],
  "searchText": "news",
  "view": "RECOMMENDED",
  "limit": 50
}

Response

Returns matching channels

statusstring
instanceIdstring

Example response

{
  "status": "success",
  "instanceId": "1234",
  "data": [
    {
      "id": {
        "server": "newsletter",
        "user": "120363184333444555",
        "_serialized": "120363184333444555@newsletter"
      },
      "t": 1701959820,
      "name": "Example Channel",
      "channelMetadata": {
        "id": {
          "server": "newsletter",
          "user": "120363184333444555",
          "_serialized": "120363184333444555@newsletter"
        },
        "creationTime": 1701959820,
        "name": "Example Channel",
        "description": "Example channel description",
        "size": 16979,
        "verified": true
      }
    }
  ]
}