v1
latestOpenAPI 3.1.02026-07-2342137210.8 KBModels
Search Models
Returns a paginated list of forecast models belonging to the authenticated organization. Supports full-text search across name, label, and external_id via the q parameter, and filtering by Saved Location ID and readiness status.
get/v1/forecasts/models
Query parameters
qstring
Fulltext search across name, label and external_id.
location.saved_location_idstring[]
A comma-separated list of Saved Location IDs to filter on.
readiness_statusstring[]
A comma-separated list of forecast model statuses to filter on.
- created: Model has been created but not yet trained.
- preparing: Model is locked and gathering data prior to training.
- training: Model is currently being trained on uploaded demand data.
- forecasting: Model is generating forecasts.
- ready: Model has successfully generated forecasts and is available for queries.
- stale: Model configuration or data has changed; retraining is required.
- failed: Processing encountered an error.
limitinteger
Maximum number of results to return per page.
offsetinteger
Zero-based index of the first result to return.
Response
Successful Response