Performance, pipeline & forecast

Pipeline records

Records behind one pipeline number — the list has exactly n records, the number shown. Keys: waterfall columns start · new · inc · in · out · dec · won · lost · end, open (all open), commit · best · pipe, att (attention) and its chips sla · idle · step · overdue. Row: t title, s company · owner, v amount, b stage or reason, d date, nav app screen ({screen: opp, id}).

GET/api/v1/pipeline/drill

Authorization

Authorizationheaderrequired

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

Module: OpportunitiesScope: crm.read

Query parameters

kstringrequired

Key.

Valuesstartnewincinoutdecwonlostendopencommitbestpipeattslaidlestepoverdue

periodstringoptionaldefault: month

Close period.

Valuesmonthnext_monthquarternext_quarteryear

minestringoptional

1 = only my opportunities.

ownerintegeroptional

Owner user id.

Errors

HTTP	error	Meaning
`400`	`invalid`	Missing or invalid field (`message` explains).
`403`	`module`	The module is off in the licence or for the user.

Request

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

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

Response