GET
/
campaign
Retrieve all campaigns
curl --request GET \
  --url https://atoms-api.smallest.ai/api/v1/campaign \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "page": 1,
  "limit": 10
}'
{
  "status": true,
  "data": {
    "campaigns": [
      {
        "_id": "<string>",
        "name": "<string>",
        "description": "<string>",
        "organization": "<string>",
        "agentId": "<string>",
        "createdBy": "<string>",
        "audienceId": "<string>",
        "participantsCount": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "isCampaignInProgress": true,
        "isCampaignCompleted": true
      }
    ]
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json

Response

200
application/json

A list of campaigns

The response is of type object.