GET /api/v1/forward/channels
Returns Channel records owned by the authenticated account.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
channel_type | string | No | - | Filter by wechat, qq, wecom, feishu, or dingtalk. |
enabled | boolean | No | - | Filter by manual enable state. |
binding_status | string | No | - | Filter by unbound, bound, or expired. |
identity_id | string | No | - | Filter by Forward Identity ID. |
template_id | string | No | - | Filter by Forward Template ID. |
limit | integer | No | 20 | Items per page. Maximum 100. |
after_id | string | No | - | Cursor for records after the given Channel ID. |
before_id | string | No | - | Cursor for records before the given Channel ID. |
Example request
Example response
HTTP 200 OKResponse fields
| Field | Type | Description |
|---|---|---|
data | array | Channel objects on the current page. |
first_id | string|null | ID of the first Channel on this page. |
last_id | string|null | ID of the last Channel on this page. |
has_more | boolean | Whether more records remain. |
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 400 | invalid_request_error | invalid_pagination | Pagination parameters are invalid. |
| 400 | invalid_request_error | channel_type_unsupported | Channel type filter is unsupported. |
| 401 | authentication_error | authentication_required | PAT invalid or expired. |
Notes
after_idandbefore_idare mutually exclusive.- Channels are returned only inside the caller’s account boundary.