Skip to main content
GET
Get Deals
Bare JSON array, ordered by created_at descending, excludes archived deals. No total-count header — see Pagination; keep incrementing offset until a page comes back shorter than limit. limit is capped at 200 server-side regardless of what you pass, and defaults to 50. Unlike Kanban Board and KPI Tiles, this endpoint has no free-text search (q) parameter — stage_id, owner_id, account_id, and geo_scope are exact-match only.

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 deal objects, each with two embedded joins:

Authorizations

Authorization
string
header
required

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

Query Parameters

stage_id
string | null

Filter to deals in this pipeline stage id, exact match.

owner_id
string | null

Filter to deals owned by this user id, exact match.

account_id
string | null

Filter to deals linked to this account id, exact match.

geo_scope
string | null

Filter to deals with this geographic scope (local, regional, or international), exact match.

limit
integer
default:50

Max deals to return; capped at 200 server-side.

offset
integer
default:0

Number of deals to skip, for pagination.

Response

Successful Response