Create your first research run
This quickstart walks through creating a research run to find businesses that match your ideal customer profile.
Authenticate
Include your API key in the Authorization header. Start with this read-only request.
GET /api/v1/account
curl --request GET \
--url https://ghostreach.xyz/api/v1/account \
--header 'Authorization: Bearer gr_live_your_key' \
--header 'Accept: application/json'Create a research run
Send a keyword and market to start a new run. This request can spend credits and start real provider work.
POST /api/v1/research/runs
curl --request POST \
--url https://ghostreach.xyz/api/v1/research/runs \
--header 'Authorization: Bearer gr_live_your_key' \
--header 'Content-Type: application/json' \
--data '{
"method": "primary",
"keyword": "roofing contractors",
"locations": { "cities": [{ "city": "Bakersfield", "state": "CA" }] }
}'Check the response
The API returns the research run identifier and its current status.
201 Created
{
"ok": true,
"data": {
"run": {
"runId": "7605f281-0dc7-4a6d-9da3-8e9d9e941d25",
"status": "queued",
"keyword": "roofing contractors"
}
},
"requestId": "req_01HZ…"
}Get your results
When the run is complete, use its identifier to retrieve the businesses GhostReach found.
GET /api/v1/research/runs/{runId}/leads
curl --request GET \
--url https://ghostreach.xyz/api/v1/research/runs/{runId}/leads \
--header 'Authorization: Bearer gr_live_your_key'