Pipeline & forecast

Pipeline summary

Open amount, weighted expected, Commit / Best Case / Pipeline, period flow (start → new, moved in / out, increased / decreased, won, lost → end), stages and opportunities needing attention (with signals). Same figures as the web Pipeline page.

GET/api/v1/pipeline

Authorization

Authorizationheaderrequired

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

Module: OpportunitiesScope: crm.read

Query parameters

periodstringoptionaldefault: month

Close period.

Valuesmonthnext_monthquarternext_quarteryear

minestringoptional

1 = only my opportunities.

ownerintegeroptional

Owner user id.

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/pipeline \
  -H "Authorization: Bearer $SOLK_API_KEY"

const res = await fetch("https://ornek.solk.app/api/v1/pipeline", {
  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/pipeline",
    headers={"Authorization": f"Bearer {os.environ['SOLK_API_KEY']}"},
)
print(r.json())

Response