Channels
Overview
The channel instances connected to your organization. An organization can have several instances of the same channel — two WhatsApp numbers, say — and the ids listed here are what you pass as channelId elsewhere in the API to target a specific one.
2 endpoints. Requires settings.view on the token.
| Method | Path | What it does |
|---|---|---|
GET | /channels | List channels |
GET | /channels/{id} | Get channel details |
Endpoints
GET /channels
List channels
List all OrgChannel instances. Credentials and tokens are not exposed.
Requires the settings.view permission.
Example
curl -X GET "https://orqestra.id/api/v2/channels" \
-H "Authorization: Bearer $ORQESTRA_TOKEN"Responds with 200 · 401. Try it in the playground →
GET /channels/{id}
Get channel details
Get a single channel with aggregate stats (chats, messages, broadcasts). Credentials are not exposed.
Requires the settings.view permission.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | required | OrgChannel ID (cuid) |
Example
curl -X GET "https://orqestra.id/api/v2/channels/$id" \
-H "Authorization: Bearer $ORQESTRA_TOKEN"Responds with 200 · 401 · 404. Try it in the playground →