Pipeline & forecast

Period forecast

Month · quarter · year: won, forecast with Commit and Best Case, target, percentage, status, coverage, win rate; deals by category, a 12-month series in month view and reps in team view. Sales users default to their own figures. Same rules as the web Forecast page.

GET/api/v1/forecast

Authorization

Authorizationheaderrequired

Bearer token: API key (sk_…), OAuth access token (mcp_…) or mobile session (xk_…).

Module: forecastScope: crm.read

Query parameters

gstringoptionaldefault: m

Period type.

Valuesmqy

pstringoptional

Period: 2026-10, 2026-Q4, 2026 (default: current).

ownerintegeroptional

User; empty = team.

Errors

HTTP	error	Meaning
`403`	`module`	The module is off in the licence or for the user.

Request

curl https://ornek.solk.app/api/v1/forecast \
  -H "Authorization: Bearer $SOLK_API_KEY"

const res = await fetch("https://ornek.solk.app/api/v1/forecast", {
  headers: {
    Authorization: `Bearer ${process.env.SOLK_API_KEY}`,
  },
});
const data = await res.json();

import os, requests

r = requests.get(
    "https://ornek.solk.app/api/v1/forecast",
    headers={"Authorization": f"Bearer {os.environ['SOLK_API_KEY']}"},
)
print(r.json())

Response