GET
/
campaigns
/
{campaignId}
curl --request GET \
  --url https://my.cald.ai/client/api/v1/campaigns/{campaignId} \
  --header 'Authorization: <api-key>'
{
  "campaignId": "<string>",
  "name": "<string>",
  "listId": "<string>",
  "agentId": "<string>",
  "status": "<string>",
  "stats": {
    "totalCalls": 123,
    "completedCalls": 123,
    "failedCalls": 123,
    "pendingCalls": 123,
    "pickedUpCalls": 123,
    "ivrCalls": 123,
    "voicemailCalls": 123,
    "unansweredCalls": 123,
    "disconnectedCalls": 123
  }
}
This endpoint returns general information about the campaign. To get more detailed information about a campaign (e.g. all call IDs), use the Get Campaign Details endpoint.

Authorizations

​
Authorization
string
header
required

Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0

Path Parameters

​
campaignId
string
required

The campaign ID of the campaign

Response

200
application/json
Campaign information

The response is of type object.