Skip to main content
POST
/
api
/
v1
/
account
/
start-search-job
Start Account Search Job
curl --request POST \
  --url https://api.openfunnel.dev/api/v1/account/start-search-job \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <x-api-key>' \
  --header 'X-User-ID: <x-user-id>' \
  --data '
{
  "query_trait": "<string>",
  "query_activity": "<string>"
}
'
{
  "job_id": "<string>",
  "status": "pending",
  "message": "Search job created successfully"
}

Headers

​
X-API-Key
string
required
​
X-User-ID
string
required

Body

application/json

Request to start account signals search job

​
query_trait
string | null

Search query describing accounts to find

​
query_activity
string | null

Search query describing accounts to find

Response

Successful Response

Response from starting search job

​
job_id
string
required
​
status
string
default:pending
​
message
string
default:Search job created successfully