List channels grouped by brand

GET

/api/v3/channels/by-brand

const url = 'https://api.tryletterhead.com/api/v3/channels/by-brand?api=true';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.tryletterhead.com/api/v3/channels/by-brand?api=true' \
  --header 'Authorization: Bearer <token>'

List every brand your company owns, each carrying its channels (slug, title, and medium — email or sms). One entry per brand.

This endpoint is gated behind an internal feature flag that is not yet enabled for any tenant. While it’s off, the endpoint returns 404 Not Found.

v3 endpoints expect a company API key.

Authorizations

bearerAuth

Parameters

Query Parameters

api

required

boolean

Required. Set to true.

Responses

200

200 OK

application/json

object

items

Array<object>

object

brand

string

name

string

channels

Array<object>

object

channel

string

title

string

type

string

message

string

total

integer

Example

{
  "items": [
    {
      "brand": "example-brand",
      "name": "Example Brand",
      "channels": [
        {
          "channel": "an-example-channel",
          "title": "An Example Channel",
          "type": "email"
        },
        {
          "channel": "an-example-sms-channel",
          "title": "An Example SMS Channel",
          "type": "sms"
        }
      ]
    }
  ],
  "message": "Channels retrieved successfully.",
  "total": 1
}

404

404 Not Found — the feature isn’t enabled for this tenant.

application/json

object

data

Array<object>

object

items

Array<object>

object

message

string

total

integer

Example

{
  "data": [],
  "items": [],
  "message": "Channel management is not enabled.",
  "total": 0
}

Still can’t find what you need? Contact support.