Skip to content

List Forecasts

GET /api/forecast

Required privilege: Forecast / View

Returns a paginated, filterable list of forecast records.


Response

{
  "data": {
    "headers": [
      { "key": "Forecast List Number", "format": "string-link", "alias": "Forecast #" },
      { "key": "Forecast List Document Status", "format": "string", "alias": "Status" },
      { "key": "Forecast List Date", "format": "date" },
      { "key": "Forecast Total Items", "format": "number" },
      { "key": "Forecast List Quantity", "format": "number" }
    ],
    "rows": [
      {
        "id": 77,
        "Forecast List Number": "FC-2024-Q1",
        "Forecast List Date": "2024-01-01",
        "Forecast Total Items": 4,
        "Forecast List Quantity": 2000,
        "Forecast List Document Status": "Active"
      }
    ]
  }
}

Code Examples

curl -b cookies.txt "https://acme.knosc.com/api/forecast"