Skip to main content
GET
/
campaign
/
{id}
Get a campaign
curl --request GET \
  --url https://atoms-api.smallest.ai/api/v1/campaign/{id} \
  --header 'Authorization: Bearer <token>'
{
  "status": true,
  "data": {
    "campaign": {
      "_id": "<string>",
      "name": "<string>",
      "description": "<string>",
      "organization": "<string>",
      "agentId": "<string>",
      "createdBy": "<string>",
      "audienceId": "<string>",
      "participantsCount": 123,
      "status": "draft",
      "maxRetries": 3,
      "retryDelay": 15,
      "scheduledAt": "2023-11-07T05:31:56Z",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    },
    "events": [
      {
        "_id": "<string>",
        "campaignId": "<string>",
        "triggerSource": "<string>",
        "eventAction": "<string>",
        "createdAt": "2023-11-07T05:31:56Z"
      }
    ],
    "metrics": {
      "total_participants": 500,
      "contacts_called": 247,
      "contacts_connected": 150
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id
string
required

The ID of the campaign

Response

Campaign details with metrics

​
status
boolean
Example:

true

​
data
object