Get channel by ID

GET

/api/channels/{channelId}

Production

Retrieve full details for a single channel including its type, configuration, and provisioning status.

Authorizations

bearerAuth

Parameters

Path Parameters

channelId

required

string format: uuid

The unique identifier of the channel to retrieve.

Responses

200

The channel was found and returned.

A channel represents a communication pathway through which oHallo sends and receives messages. Each channel has a type, configuration, and provisioning status.

object

required

Unique identifier for the channel.

string format: uuid

Example

d4e5f6a7-b8c9-0123-4567-890abcdef012

workspaceId

required

Workspace the channel belongs to.

string format: uuid

Example

a1b2c3d4-e5f6-7890-abcd-ef1234567890

channelType

required

Channel type: email, chat, whatsapp, or voice.

string

Example

email

displayName

required

Human-readable name.

string

Example

Support Email

status

required

Provisioning status: active, pending_dns, provisioning, or error.

string

Example

active

config

Channel-specific configuration (non-sensitive settings only).

object | null

Example

{
  "inboundAddress": "support@nordic-parts.dk",
  "fromName": "Nordic Parts Support"
}

createdAt

required

Timestamp when the channel was created.

string format: date-time

Example

2026-01-10T08:00:00.000Z

404

No channel exists with the given ID in the authenticated tenant.

Standard error response returned by all endpoints on failure.

object

error

required

A human-readable error message describing what went wrong.

string

Example

Conversation not found