Get one channel's connection state
One channel's state, in the same shape the collection returns.
/v1/channels/{channel}Viewer- Operation id
- get_channel
- Access
- Any workspace role can call this.
/v1/channels/{channel}One channel's state, in the same shape the collection returns.
A channel that has an adapter but no stored connection is a 200 describing an unconnected channel, not a 404. That is the same distinction the list makes. Only a channel that is neither registered nor connected is absent, and that is the 404.
So a 200 here does not mean the channel is in use. Read connected and
enabled for that.
Tenancy: the request is scoped to one workspace, and the credential presented is what selects it. A caller with no membership in that workspace is refused with 404, which is indistinguishable from a workspace that does not exist.
Authorisation: any workspace role, including viewer. Reads are open to every member.
Access: Authorization: Bearer carrying either a realm access token or an API key. A key must hold the channels:read scope, and the workspace role of the person who owns it must meet the floor above.
A realm-issued access token, presented as Authorization: Bearer <token>. It acts as the person who signed in, and every operation resolves their workspace role live from the membership record.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/channels/string"{ "channel": "sms", "display_name": "Support SMS", "adapter_available": true, "ticket_source": "sms", "handle_kind": "phone_number", "outbound_supported": false, "inbound_path": "/v1/ingest/sms", "details": {}, "connected": true, "enabled": true, "config": { "from_number": "+15550199", "auth_token": "***" }, "created_at": "2026-05-19T15:22:00+00:00", "updated_at": "2026-08-14T08:10:00+00:00"}