Get Deals
Deals
List Deals
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 ofcontacts: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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Filter to deals in this pipeline stage id, exact match.
Filter to deals owned by this user id, exact match.
Filter to deals linked to this account id, exact match.
Filter to deals with this geographic scope (local, regional, or international), exact match.
Max deals to return; capped at 200 server-side.
Number of deals to skip, for pagination.
Response
Successful Response