CRM
List Deals
Deals in board order (pipeline, stage, position). Filter by `pipeline_id`, `stage_id`, `status` (repeatable), `owner_id`, `company_id`, `lead_id` (a person on the deal) or `q` (deal or company name).
API key access
Needs the
crm:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.GET
/api/v1/dealsAuthorizationBearer <token>
Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Query Parameters
pipeline_id?string
Format
uuidstage_id?string
Format
uuidstatus?array<DealStatus>
owner_id?string
Format
uuidcompany_id?string
Format
uuidlead_id?string
Format
uuidq?string
Length
length <= 200limit?integer
Default 200
Format
int64Range
1 <= value <= 500cursor?string
next_cursor of the previous page
Header Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/deals?pipeline_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&stage_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=open&owner_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&company_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&lead_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&q=string&limit=1&cursor=string" \ -H "X-Workspace-Id: string"{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"pipeline_id": "ec036e81-7903-4e4d-bbfa-ac8516341cf0",
"stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670",
"stage_name": "string",
"name": "string",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"company_name": "string",
"value": 0,
"currency": "string",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"close_date": "2019-08-24",
"probability": 0,
"probability_set": true,
"weighted_value": 0,
"next_step": "string",
"position": 0.1,
"status": "open",
"closed_at": "2019-08-24T14:15:22Z",
"contacts": [
{
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"name": "string",
"email": "string",
"title": "string"
}
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
],
"next_cursor": "string"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}