Skip to main content
POST
/
research
Submit research request
curl --request POST \
  --url https://api.rapportapi.com/research \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_data": {
    "email": "jane@example.com"
  },
  "callback_url": "https://yourapp.com/webhooks/rapport",
  "callback_secret": "your_webhook_secret"
}
'
{
  "task_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "prospect_id": null,
  "status": "pending"
}

Authorizations

​
Authorization
string
header
required

API key with rapi_live_ prefix

Body

application/json
​
contact_data
object
required

Contact identifiers. At least one of: email, linkedin_url, or full_name + company.

​
prospect_id
string

Your internal ID for this prospect (echoed back in responses and webhooks)

​
callback_url
string<uri>

URL to receive a webhook POST when research completes

​
callback_secret
string

Bearer token sent in the Authorization header of webhook callbacks

Response

Research request accepted

​
task_id
string<uuid>

Unique task ID for polling

​
prospect_id
string | null

Your prospect_id if provided

​
status
enum<string>

Initial status is always 'pending'

Available options:
pending