Read the sales forecast

Covers deals expected to close in the current month, quarter or year (UTC), or created in it when they have no close date. Open value is weighted by each deal win chance, and won value is compared with the targets set in the dashboard.

GEThttps://app.softsolz.uk/api/v1/services/pipelines/pipelines/forecast

Recent Requests

Kept only in this browser

TimeStatusTook

Send a request with Try it to see it here.

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Query Params

pipeline_idstring

Only include deals on this board. Leave out to cover every board.

periodstring

month, quarter or year (default quarter).

Response

Response Body

periodstringThe period asked for.

period_startstringFirst day of the period (UTC).

period_endstringFirst day after the period (UTC).

won_centsintegerTotal value won in the period.

open_centsintegerTotal open value.

weighted_centsintegerTotal open value weighted by win chance.

target_centsintegerTeam target for the period, or the sum of owner targets when none is set.

attainmentnumber | nullWon value as a percentage of target; null with no target.

ownersarray of objectsOne row per owner, highest won value first.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/pipelines/pipelines/forecast \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Authorization

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": {
    "period": "quarter",
    "period_start": "2026-10-01",
    "period_end": "2027-01-01",
    "won_cents": 0,
    "open_cents": 480000,
    "weighted_cents": 48000,
    "target_cents": 0,
    "attainment": null,
    "owners": [
      {
        "owner_user_id": null,
        "owner_name": "Unassigned",
        "won_cents": 0,
        "open_cents": 480000,
        "weighted_cents": 48000,
        "target_cents": 0,
        "attainment": null,
        "open_deals": 1,
        "won_deals": 0
      }
    ]
  }
}