The campaign's call log — every lead + its outcome
GET
https://server.heyrik.com/api/v1/campaigns/{id}/contactsPath parameters
idRequiredReplace {id} in the request URL with the value for this resource.
Headers
AuthorizationstringRequiredUse Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.
Parameters 3
Fields documented for this operation. See the request example for placement and structure.
statusstringFilter: pending | calling | completed | failed | retry.
categorystringFilter by the classify bucket the agent tagged (hot / warm / cold…).
limit / offsetnumberPagination. limit default 500, max 2000.
GET/campaigns/{id}/contacts
curl "https://server.heyrik.com/api/v1/campaigns/cmp_4a19/contacts?status=completed&limit=100" \
-H "Authorization: Bearer $HEYRIK_API_KEY"Response example
{
"data": [
{
"id": "bcc_9a11",
"phone": "+919876543210",
"variables": { "name": "Ravi", "order_id": "AC-8842" },
"status": "completed",
"attempts": 1,
"call_id": "call_1dd990f7",
"outcome": "confirmed",
"category": "hot",
"summary": "Confirmed the site visit for Saturday.",
"extracted": { "budget": "80L", "timeline": "1 month" }
}
]
}Illustrative examples · No live request is sent