List Configurations
GET/api/inventory-forecasting/configurations
List all forecast configurations (non-paginated). Includes schedule counts.
purchase-orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Returns all configurations matching filters as a collection.
Each configuration carries an is_default boolean: true when it is the calling user's default. The default is per user and per tenant, so the same configuration can be is_default: true for one user and false for another.
Make / buy / transfer plans: warehouse_ids (integer[]), horizon_days (integer 7–365, default 90) and include_make (boolean) save a unified plan's scope. A configuration with warehouses (or no suppliers, or include_make true) runs as a make / buy / transfer plan — supplier_ids then becomes an optional filter and may be empty. One with suppliers and no warehouses stays a per-supplier purchase forecast. Schedules running a plan configuration build the plan and, when they auto-create, raise purchase orders only.
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.