GET /api/v1/forward/schedule_runs
Lists Schedule Runs for an Identity. Pass schedule_id to narrow results to one Schedule.
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT> |
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
identity_id | string | Yes | Forward Identity ID that owns the runs. | |
schedule_id | string | No | - | Filter by Schedule ID. |
status | string | No | - | Filter by pending, running, completed, failed, or skipped. |
trigger_type | string | No | - | Filter by schedule or manual. |
has_error | boolean | No | - | Filter to runs with or without an error. |
limit | integer | No | 20 | Items per page. Maximum 100. |
after_id | string | No | - | Cursor for records after the given Run ID. |
before_id | string | No | - | Cursor for records before the given Run ID. |
Example request
Example response
HTTP 200 OKResponse fields
| Field | Type | Description |
|---|---|---|
data | array | Schedule Run objects on the current page. |
first_id | string|null | ID of the first run on this page. |
last_id | string|null | ID of the last run on this page. |
has_more | boolean | Whether more records remain. |
data[] item is a Schedule Run object with the same fields documented by Get Schedule Run, including trigger_context, error, push_sink, push_status, and execution timestamps.
Errors
| HTTP | Type | Code | Trigger |
|---|---|---|---|
| 400 | invalid_request_error | invalid_identity | identity_id is missing or invalid. |
| 400 | invalid_request_error | invalid_pagination | Pagination parameters are invalid. |
| 401 | authentication_error | authentication_required | PAT invalid or expired. |
Notes
- Schedule Runs are independent resources.
completed,failed, andskippedare terminal statuses.push_statusdescribes IM streaming delivery and is independent from the main runstatus.