List Forward schedules for an Identity with cursor pagination.
Request headers
|
Header |
Required |
Description |
|
|
Yes |
|
Query parameters
|
Parameter |
Type |
Required |
Default |
Description |
|
|
string |
Yes |
Forward Identity ID that owns the Schedule. |
|
|
|
string |
No |
- |
Filter by Forward Template ID. |
|
|
string |
No |
- |
Filter by |
|
|
boolean |
No |
|
Include archived schedules. |
|
|
integer |
No |
20 |
Items per page. Maximum 100. |
|
|
string |
No |
- |
Cursor for records after the given Schedule ID. |
|
|
string |
No |
- |
Cursor for records before the given Schedule ID. |
Example request
curl -s -X GET 'https://api.qoder.com.cn/api/v1/forward/schedules?identity_id=idn_019eabc123&limit=20' \
-H "Authorization: Bearer $QODER_PAT"
Example response
HTTP 200 OK
{
"data": [
{
"id": "sched_019f00112233445566778899aabbccdd",
"identity_id": "idn_019eabc123",
"template_id": "tmpl_support",
"name": "Daily tech brief",
"description": "Generate a daily technology news summary",
"status": "active",
"paused_reason": null,
"initial_events": [
{
"type": "user.message",
"content": "Summarize current technology news in five bullet points."
}
],
"execution": {
"session_mode": "new_session",
"max_concurrent_runs": 1,
"max_attempts": 1,
"timeout_ms": 300000
},
"trigger_policy": {
"type": "cron",
"expression": "0 9 * * *",
"timezone": "Asia/Shanghai",
"upcoming_runs_at": ["2026-06-23T01:00:00Z"]
},
"environment_id": "env_019e64e01a137caf953ac2ac7b42ec5c",
"sinks": [],
"metadata": {},
"archived_at": null,
"created_at": "2026-06-22T10:00:00Z",
"updated_at": "2026-06-22T10:00:00Z"
}
],
"first_id": "sched_019f00112233445566778899aabbccdd",
"last_id": "sched_019f00112233445566778899aabbccdd",
"has_more": false
}
Response fields
|
Field |
Type |
Description |
|
|
array |
Full Schedule objects on the current page. |
|
|
string|null |
ID of the first record on this page. |
|
|
string|null |
ID of the last record on this page. |
|
|
boolean |
Whether more records remain. |
Errors
|
HTTP |
Type |
Code |
Trigger |
|
400 |
|
|
|
|
400 |
|
|
Pagination parameters are invalid. |
|
401 |
|
|
PAT invalid or expired. |
Notes
-
Results are returned in descending creation order.
-
Archived records are returned only when
include_archived=true.