Skip to main content
GET /api/v1/forward/schedules Returns Schedule configuration records. Archived schedules are excluded by default.

​
Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>

​
Query parameters

ParameterTypeRequiredDefaultDescription
identity_idstringYesForward Identity ID that owns the Schedule.
template_idstringNo-Filter by Forward Template ID.
statusstringNo-Filter by active or paused.
include_archivedbooleanNofalseInclude archived schedules.
limitintegerNo20Items per page. Maximum 100.
after_idstringNo-Cursor for records after the given Schedule ID.
before_idstringNo-Cursor for records before the given Schedule ID.

​
Example request

curl -s -X GET 'https://api.qoder.com/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

FieldTypeDescription
dataarrayFull Schedule objects on the current page.
first_idstring|nullID of the first record on this page.
last_idstring|nullID of the last record on this page.
has_morebooleanWhether more records remain.

​
Errors

HTTPTypeCodeTrigger
400invalid_request_errorinvalid_identityidentity_id is missing or invalid.
400invalid_request_errorinvalid_paginationPagination parameters are invalid.
401authentication_errorauthentication_requiredPAT invalid or expired.

​
Notes

  • Results are returned in descending creation order.
  • Archived records are returned only when include_archived=true.

Create a schedule

List schedule runs