List the leads in a campaign
Leads in a campaign with approval and copy status.
GET/api/v1/campaigns/{id}/leads
Parameters
Path
| Name | In | Description |
|---|---|---|
idrequired | path | The record's id. |
Query
| Name | In | Description |
|---|---|---|
status | query | approved, rejected, pending. |
q | query | Search text. |
copy | query | ready, flagged, missing. |
Example
curl
curl -X GET "https://crm.ashwanth.dev/api/v1/campaigns/{id}/leads" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY"CLI
sales-engine campaigns leads <id>Response
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.
Path
requiredThe record's id.
Query
approved, rejected, pending.
Search text.
ready, flagged, missing.
Request
GET /api/v1/campaigns/%7Bid%7D/leads
Fill the path first.