Browse docs

Channels

Overview

Channels are the communication sources through which tickets are received (email inboxes or embedded support widgets). The API exposes read access. Creation and configuration are done through the workspace UI.

List Channels

Retrieves all channels in the workspace that the authenticated user and token have access to.

GET /api/channels

Example Response

{
    "data": [
        {
            "id": 1,
            "ulid": "01hx9f3k2a...",
            "name": "Support",
            "type": "email",
            "color": "#3b82f6",
            "email_address": "support@there-there.app"
        },
        {
            "id": 3,
            "ulid": "01hx9g4m3r...",
            "name": "Website Widget",
            "type": "widget",
            "color": "#8b5cf6",
            "email_address": null
        }
    ]
}

The type field indicates the channel source (email or widget).

Show Channel

GET /api/channels/{channel}

Returns a single channel by ULID. If the token or user does not have access to this channel, the response is 404.