curl --request GET \
--url https://api.example.com/deals/board \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/deals/board"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/deals/board', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/deals/board",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/deals/board"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/deals/board")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/deals/board")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Kanban Board
Kanban board columns without loading every deal.
Per visible stage returns the true count + pipeline value (from the
insights_pipeline_by_stage aggregate view) plus only the top limit
deals (a bounded SELECT). Replaces the old unbounded /deals?select=*
board fetch that returned the org’s entire deal set.
Faceted filters (owner / stage / account as comma-separated ids,
risk flag, close_from / close_to and created_from /
created_to date windows) narrow the columns.
curl --request GET \
--url https://api.example.com/deals/board \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.example.com/deals/board"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.example.com/deals/board', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/deals/board",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/deals/board"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.example.com/deals/board")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/deals/board")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}insights_pipeline_by_stage aggregate view) plus only the top limit deals — replacing an older /deals?select=* fetch that loaded the org’s entire pipeline into memory (see the CPU-incident history for why this matters).
owner, stage, account, and geo are each comma-separated id lists, not single ids. risk=true restricts to deals where close_date is past or last_activity_at is 14+ days old. created_from/created_to treat the end date as inclusive of the whole day. limit applies per stage column, not to the total response, and is capped at 200.Auth
Requires a CRM read scope and an active organization on the token. Any ofcontacts:read, deals:read, companies:read, or activities:read qualifies, as does any *:manage scope — manage implies read.
Response
Array of column objects, one per visible stage:| Field | Type | Description |
|---|---|---|
stage | object | {id, name, color, position, is_won, is_lost, is_hidden}. |
count | integer | True count for the stage. When any filter/search is active, this is the exact matched count instead of the precomputed aggregate. |
value | number | Pipeline value for the stage. Under an active filter, this is the sum of only the loaded slice (approximate if more rows exist beyond limit). |
deals | array | Up to limit deals, each {id, name, value, currency, close_date, stage_id, last_activity_at, health_score, geo_scope, accounts: {name}, deal_stages: {...}, contacts: [...]} — contacts is every linked contact (id, first_name, last_name, title, email), not just one. |
hasMore | boolean | true if count > deals.length. |
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Field to sort each column's deals by: value, close_date, last_activity, or name; unrecognized values fall back to value.
Sort direction: asc or desc.
Free-text search narrowing the board to matching deals.
Max deals to return per stage column (not the total response); capped at 200.
Comma-separated owner user ids to filter to.
Comma-separated pipeline stage ids to filter to.
Comma-separated account ids to filter to.
Comma-separated geographic scopes to filter to.
Restrict to at-risk deals (close date past, or no activity in 14+ days).
Only include deals with close_date on/after this date.
Only include deals with close_date on/before this date (inclusive of the whole day).
Only include deals created on/after this date.
Only include deals created on/before this date (inclusive of the whole day).
Response
Successful Response