Lead listsOperation leadLists.preview

Preview a lead search

Preview how many people match a search and what it would cost, before sourcing.

POST/api/v1/lead-lists/preview

Scope read: Read anything in the workspace.

Parameters

Body

A JSON object. Fields not listed are ignored.

Name	In	Description
`mode`	body	form or natural_language. One of `form`, `natural_language`.
`description`	body	Who you are looking for, in natural_language mode.
`filters`	body, object	{titles, seniorities, industries, employee_ranges, person_locations, org_locations, domains, keywords}.
`use_icp_defaults`	body, boolean	Fill empty filters from the default ICP.
`icp_profile_id`	body	ICP profile to draw defaults from.
`options`	body, object	{verify, verify_mode, profile_tier, posts, research, phone}.
`provider`	body	apollo, moltsets or leadocean. One of `apollo`, `moltsets`, `leadocean`.
`requested_count`	body, integer	How many leads the list would ask for; result.availability says the matches and whether they cover 70 percent of it (enough). No CRM check: the build skips duplicates.

Example

curl

curl -X POST "https://crm.ashwanth.dev/api/v1/lead-lists/preview" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "mode": "form",
  "description": "",
  "filters": {},
  "use_icp_defaults": false,
  "icp_profile_id": "",
  "options": {},
  "provider": "apollo",
  "requested_count": 0
}'

CLI

sales-engine lead-lists preview

The JSON above lists every documented field with a typed placeholder; send only the ones you mean.

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.

API 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.

Body (JSON)

Every documented field is listed above; leave out the ones you do not need.

Request

POST /api/v1/lead-lists/preview