メインコンテンツへスキップ
GET /api/v1/forward/schedules Schedule 設定レコードを返します。アーカイブ済みのスケジュールはデフォルトで除外されます。

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>

Query parameters

ParameterTypeRequiredDefaultDescription
identity_idstringYesSchedule を所有する Forward Identity ID。
template_idstringNo-Forward Template ID でフィルタリングします。
statusstringNo-active または paused でフィルタリングします。
include_archivedbooleanNofalseアーカイブ済みのスケジュールを含めます。
limitintegerNo201 ページあたりの項目数。最大 100。
after_idstringNo-指定した Schedule ID より後のレコードのカーソル。
before_idstringNo-指定した 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
dataarray現在のページの完全な Schedule オブジェクト。
first_idstring|nullこのページの最初のレコードの ID。
last_idstring|nullこのページの最後のレコードの ID。
has_morebooleanさらにレコードが残っているかどうか。

Errors

HTTPTypeCodeTrigger
400invalid_request_errorinvalid_identityidentity_id が欠落しているか無効です。
400invalid_request_errorinvalid_paginationページネーションパラメータが無効です。
401authentication_errorauthentication_requiredPAT が無効または期限切れです。

Notes

  • 結果は作成日時の降順で返されます。
  • アーカイブ済みのレコードは include_archived=true の場合のみ返されます。

スケジュールを作成する

スケジュール実行を一覧表示する