Skip to content

List Schedule Runs

GET/v1/schedules/{schedule_id}/runs

List Runs with offset pagination (limit 1-100). Read one Run with GET /v1/schedules/{schedule_id}/runs/{run_id}; Schedule Run reads are read-only and status advances in the background. Request cancellation of a pending Run with POST /v1/schedules/{schedule_id}/runs/{run_id}/cancel (Idempotency-Key required, body {}). Cancel only reaches a Run whose Session has started: while session_id is null it returns 409 conflict, and while the Run input is still being delivered it returns 409 session_input_pending; in that state the Run may not be cancellable, so wait for it to finish. Cancelling a Run that has already finished returns 202 with the unchanged Run. Read notification deliveries with GET /v1/schedules/{schedule_id}/runs/{run_id}/notifications.

Path parameters

stringschedule_idrequired

Schedule ID (sch_ prefix).

Query parameters

Optional<integer>limit

Page size up to 100; values above 100 return 400, and 0 or non-numeric values fall back to 20.

Default: 20

Optional<integer>offset

Number of records to skip.

Default: 0

Run object

Returned by every Run operation.

stringstatusrequired

pending, succeeded, failed, or cancelled; skipped when a scheduled tick finds a pending Run (error_code concurrency_limit).

string · nullsession_idrequired

Session created for the Run; null until it exists.

Optional<string>error_code

Set when the Run failed, for example session_creation_rejected, execution_failed, or spending_limit_exceeded.

stringtrigger_sourcerequired

manual or scheduled.