Deals list
Deals in pipeline order with the next and last call and whether a recording exists.
GET/api/v1/deals
Parameters
Query
| Name | In | Description |
|---|---|---|
lead_id | query | Only the deals linked to this lead. |
stage | query | booked, prepped, held, follow_up, no_show, proposal_sent, won or lost. One of booked, prepped, held, follow_up, no_show, proposal_sent, won, lost. |
q | query | Search the title, contact, email and company. |
Example
curl
curl -X GET "https://crm.ashwanth.dev/api/v1/deals" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY"CLI
sales-engine deals listResponse
A 200 with the result under data, on creation too. Errors come back as an error object with a stable code; see Errors.
Shape
{
"data": { ... }
}Run it below to see the live shape for your workspace.
Try it
Runs against this server, as the workspace behind the key. Kept in this page while you browse the docs, gone on reload, never stored. Signed in to the app? Leave it blank and the call runs as you.
Query
Only the deals linked to this lead.
booked, prepped, held, follow_up, no_show, proposal_sent, won or lost.
Search the title, contact, email and company.
Request
GET /api/v1/deals