Skip to main content
GET
Get Deals Board
Returns board columns without loading every deal: per visible stage, the true count and pipeline value (from the 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).
The query parameters below accept plain strings, so the auto-rendered parameter list doesn’t show their exact semantics: 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 of contacts: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:

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

sort
string
default:value

Field to sort each column's deals by: value, close_date, last_activity, or name; unrecognized values fall back to value.

dir
string
default:desc

Sort direction: asc or desc.

q
string | null

Free-text search narrowing the board to matching deals.

limit
integer
default:50

Max deals to return per stage column (not the total response); capped at 200.

owner
string | null

Comma-separated owner user ids to filter to.

stage
string | null

Comma-separated pipeline stage ids to filter to.

account
string | null

Comma-separated account ids to filter to.

geo
string | null

Comma-separated geographic scopes to filter to.

risk
boolean
default:false

Restrict to at-risk deals (close date past, or no activity in 14+ days).

close_from
string | null

Only include deals with close_date on/after this date.

close_to
string | null

Only include deals with close_date on/before this date (inclusive of the whole day).

created_from
string | null

Only include deals created on/after this date.

created_to
string | null

Only include deals created on/before this date (inclusive of the whole day).

Response

Successful Response