The campaign's call log — every lead + its outcome

GEThttps://server.heyrik.com/api/v1/campaigns/{id}/contacts

Path parameters

idRequired

Replace {id} in the request URL with the value for this resource.

Headers

AuthorizationstringRequired

Use Bearer $HEYRIK_API_KEY with an account-scoped API key. Keep the key on your server.

Get your API key

Parameters 3

Fields documented for this operation. See the request example for placement and structure.

statusstring

Filter: pending | calling | completed | failed | retry.

categorystring

Filter by the classify bucket the agent tagged (hot / warm / cold…).

limit / offsetnumber

Pagination. limit default 500, max 2000.

Response

Explore the example values. This is not a complete response schema.

dataarray

Explore 1 example item

[0]object

Explore 10 properties

idstring

Example "bcc_9a11"

phonestring

Example "+919876543210"

variablesobject

Explore 2 properties

namestring

Example "Ravi"

order_idstring

Example "AC-8842"

statusstring

Example "completed"

attemptsnumber

Example 1

call_idstring

Example "call_1dd990f7"

outcomestring

Example "confirmed"

categorystring

Example "hot"

summarystring

Example "Confirmed the site visit for Saturday."

extractedobject

Explore 2 properties

budgetstring

Example "80L"

timelinestring

Example "1 month"

Error reference

GET/campaigns/{id}/contacts

cURL

curl "https://server.heyrik.com/api/v1/campaigns/cmp_4a19/contacts?status=completed&limit=100" \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{
  "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