Research preview
Preview a map before building it: find the company on the chosen source and count the people at each level of the depth. Counts only, nobody is enriched. Returns a job; read its result for the company, the levels and the total.
POST/api/v1/research/preview
Parameters
Body
A JSON object, required. Fields not listed are ignored.
| Name | In | Description |
|---|---|---|
inputrequired | body | Company name, domain or person name. |
kind | body | auto, company_name, domain or person_name. One of auto, company_name, domain, person_name. |
person_hint | body | Company hint when the input is a person. |
depth | body | auto, vp_plus, svp_plus or director_plus. One of auto, vp_plus, svp_plus, director_plus. |
provider | body | apollo (default), moltsets or leadocean. One of apollo, moltsets, leadocean. |
Example
curl
curl -X POST "https://crm.ashwanth.dev/api/v1/research/preview" \
-H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"input": "",
"kind": "auto",
"person_hint": "",
"depth": "auto",
"provider": "apollo"
}'CLI
sales-engine research preview --input "..."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. 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.
Every documented field is listed above; leave out the ones you do not need.
Request
POST /api/v1/research/preview