Skip to main content
Schedules

Get a schedule

Retrieve a Forward Schedule by ID.

GET /api/v1/forward/schedules/{schedule_id} Returns a complete Schedule object. Archived schedules remain queryable by ID.

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT or SAT>

Path parameters

ParameterTypeRequiredDescription
schedule_idstringYesForward Schedule ID.

Example request

curl -s -X GET 'https://api.qoder.com/api/v1/forward/schedules/sched_019f00112233445566778899aabbccdd' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

HTTP 200 OK 
{
  "id": "sched_019f00112233445566778899aabbccdd",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "name": "Daily tech brief",
  "description": "Generate a daily technology news summary",
  "status": "active",
  "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": 2,
    "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": [
    {
      "type": "im_channel",
      "channel_pairing_id": "pair_019eabc123"
    }
  ],
  "metadata": {},
  "created_at": "2026-06-22T10:00:00Z",
  "updated_at": "2026-06-22T10:00:00Z"
}

Response fields

Returns the Schedule object. The execution.max_attempts field in the response is the public execution policy. Default is 1, allowed values are 1 or 2. A value of 2 means the server may automatically retry once after the first execution fails. Whether a retry actually occurred is determined by the attempt field on Schedule Run objects.

Errors

HTTPTypeCodeTrigger
401authentication_errorauthentication_requiredPAT or SAT invalid or expired.
404not_found_errorschedule_not_foundSchedule does not exist or is not visible to the caller.

Notes

  • status is only active or paused; archive state is expressed by archived_at.
  • Schedule objects do not expose runtime-private fields such as Vaults, Memory Stores, or raw environment variables.

Update a schedule

List schedule runs

First steps
Define your agent
Configure agent environment
Delegate work to your agent
Agent integrations
Manage agent context
Account
Best Practices
Announcements
API reference