Retrieve one Schedule Run by ID.
GET /api/v1/forward/schedule_runs/{run_id}
Returns a single Schedule Run execution record. identity_id may be provided as an additional ownership constraint. To retrieve the input selected for this Run, pass include_initial_events=true.
This endpoint only allows a PAT or administrator SAT; an Identity-bound SAT cannot call it even when specifying its own identity_id.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT or administrator SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
run_id | string | Yes | Schedule Run ID. |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identity_id | string | No | - | Optional additional ownership constraint. |
include_initial_events | boolean | No | false | When true, returns the bound input snapshot for the current attempt when available. |
Example request
Example response
HTTP 200 OK
Response fields
Returns the complete Schedule Run object. Trigger context and error types are also defined in the shared schemas.
Query input snapshot
initial_events, as in this response excerpt:
initial_eventsis the bound input for the Run's current or finalattempt, corresponding toinitial_events_version. It is not the current Schedule configuration and does not list inputs for historical attempts.- If input is not yet bound, a historical record cannot be confirmed, or the binding is invalid,
initial_eventsis omitted. It is not replaced withnull, an empty array, or the current Schedule input. - A snapshot records the selected input; it does not prove that the runtime received it or executed successfully.
- Omitting the parameter, passing
false, or passing an empty value preserves the default response. Run lists, manual-run responses, and Webhooks do not include the full input.
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 400 | invalid_request_error | invalid_include_initial_events | include_initial_events is not a valid boolean value. |
| 404 | not_found_error | schedule_run_not_found | The Run does not exist, does not belong to the current owner, or does not satisfy the identity_id constraint. |
| 401 | authentication_error | - | The PAT or SAT is invalid or expired. |
| 403 | permission_error | - | An Identity-bound SAT calls an endpoint that only allows a PAT or administrator SAT; message is admin service account token required, and the response does not include error.code. |
Notes
error.type=concurrency_limit_reachedmeans a run was recorded but skipped due tomax_concurrent_runs.- Poll this endpoint until
statusenters a terminal state.