List campaigns with live counts

GEThttps://server.heyrik.com/api/v1/campaigns

Headers

AuthorizationstringRequired

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

Get your API key

Parameters 1

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

agency_idstring

Only campaigns run by this agent.

Response

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

dataarray

Explore 1 example item

[0]object

Explore 6 properties

idstring

Example "cmp_4a19"

namestring

Example "July outreach"

statusstring

Example "running"

agency_idstring

Example "agc_9f2a1c30"

totalnumber

Example 250

countsobject

Explore 6 properties

pendingnumber

Example 132

callingnumber

Example 1

completednumber

Example 108

failednumber

Example 9

retrynumber

Example 0

totalnumber

Example 250

Error reference

GET/campaigns

cURL

curl https://server.heyrik.com/api/v1/campaigns \
  -H "Authorization: Bearer $HEYRIK_API_KEY"

Response example

JSON

{
  "data": [
    {
      "id": "cmp_4a19",
      "name": "July outreach",
      "status": "running",
      "agency_id": "agc_9f2a1c30",
      "total": 250,
      "counts": { "pending": 132, "calling": 1, "completed": 108, "failed": 9, "retry": 0, "total": 250 }
    }
  ]
}

Illustrative examples · No live request is sent