ResearchOperation research.create

Research a company or a person

Research a company or a person: resolve, map the executive org, infer reporting lines, rank entry points, write the intelligence report.

POST/api/v1/research

Scope write: Create and edit lists, research, sequences, campaigns, memory, signals and learning; queue jobs.

Parameters

Body

A JSON object, required. Fields not listed are ignored.

Name	In	Description
`input`required	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 researching a person.
`depth`	body	auto, vp_plus, svp_plus or director_plus. One of `auto`, `vp_plus`, `svp_plus`, `director_plus`.
`max_people`	body, integer	Cap on executives, 3 to 120.
`actor_tier`	body	LinkedIn profile depth: cheap, full or none. One of `cheap`, `full`, `none`.
`provider`	body	apollo (default), moltsets or leadocean. One of `apollo`, `moltsets`, `leadocean`.

Example

curl

curl -X POST "https://crm.ashwanth.dev/api/v1/research" \
  -H "Authorization: Bearer $SALES_ENGINE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "input": "",
  "kind": "auto",
  "person_hint": "",
  "depth": "auto",
  "max_people": 0,
  "actor_tier": "cheap",
  "provider": "apollo"
}'

CLI

sales-engine research create --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.

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/research