List external IM channels with filters and cursor pagination.
Request headers
|
Header |
Required |
Description |
|
|
Yes |
|
Query parameters
|
Parameter |
Type |
Required |
Default |
Description |
|
|
string |
No |
- |
Filter by |
|
|
boolean |
No |
- |
Filter by manual enable state. |
|
|
string |
No |
- |
Filter by |
|
|
string |
No |
- |
Filter by Forward Identity ID. |
|
|
string |
No |
- |
Filter by Forward Template ID. |
|
|
integer |
No |
20 |
Items per page. Maximum 100. |
|
|
string |
No |
- |
Cursor for records after the given Channel ID. |
|
|
string |
No |
- |
Cursor for records before the given Channel ID. |
Example request
curl -s -X GET 'https://api.qoder.com.cn/api/v1/forward/channels?identity_id=idn_019eabc123&limit=20' \
-H "Authorization: Bearer $QODER_PAT"
Example response
HTTP 200 OK
{
"data": [
{
"id": "ci_019eabc123",
"type": "channel",
"identity_id": "idn_019eabc123",
"template_id": "tmpl_support",
"channel_type": "feishu",
"name": "Support Feishu channel",
"enabled": true,
"binding_status": "bound",
"created_at": "2026-06-18T10:00:00Z",
"updated_at": "2026-06-18T10:00:00Z"
}
],
"first_id": "ci_019eabc123",
"last_id": "ci_019eabc123",
"has_more": false
}
Response fields
|
Field |
Type |
Description |
|
|
array |
Channel objects on the current page. |
|
|
string|null |
ID of the first Channel on this page. |
|
|
string|null |
ID of the last Channel on this page. |
|
|
boolean |
Whether more records remain. |
Errors
|
HTTP |
Type |
Code |
Trigger |
|
400 |
|
|
Pagination parameters are invalid. |
|
400 |
|
|
Channel type filter is unsupported. |
|
401 |
— |
|
PAT invalid or expired. |
Notes
-
after_idandbefore_idare mutually exclusive. -
Channels are returned only inside the caller's account boundary.