List leads
Leads across the workspace with filters.
GET/api/v1/leads
Parameters
Query
| Name | In | Description |
|---|---|---|
q | query | Search text. |
list_id | query | Only this list. |
stage | query | Stage. |
email_status | query | Email status. |
source | query | search, upload, research, signal or reply. |
phone | query | has or none: leads with or without a phone number. One of has, none. |
limit | query, integer | Rows. |
offset | query, integer | Offset. |
Example
curl
curl -X GET "https://crm.ashwanth.dev/api/v1/leads" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY"CLI
sales-engine leads 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
Search text.
Only this list.
Stage.
Email status.
search, upload, research, signal or reply.
has or none: leads with or without a phone number.
Rows.
Offset.
Request
GET /api/v1/leads