Retrieve a Channel by ID.
GET /api/v1/forward/channels/{channel_id}
Returns Channel binding and status details.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
channel_id | string | Yes | Channel ID. Same value as the Channel object's id. |
Example request
Example response
HTTP 200 OK
Response fields
Returns the Channel object.
Error codes
| HTTP | Type | Trigger |
|---|---|---|
| 401 | authentication_error | PAT or SAT is invalid or expired. |
| 404 | not_found_error | Channel does not exist or is not visible to the caller. |
Notes
binding_statusis system-maintained and cannot be directly changed by Update Channel.- A channel can handle inbound messages only when
enabled=trueandbinding_status="bound". identity_resolution.modeisfixedorpairing. Inpairingmode,identity_idandtemplate_idare bothnull.