List All Runs
GET/api/inventory-forecasting/schedule-runs
Get all forecast runs across all schedules (both manual and scheduled), paginated. Loads the schedule, triggering user, and linked purchase orders.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Authentication: Requires Bearer token.
Text search uses filter[search] (matches run ID, schedule name, or user name). Advanced filtering uses filter_groups — a base64-encoded tree of AND/OR condition groups over: id, status, run_type (manual or scheduled), started_at, purge_at, created_at, updated_at. Sortable: id, started_at, status, run_type, purge_at (default -started_at, newest first).
Request
Responses
- 200
- 401
- 403
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.