Retrieve all campaigns

GET

https://api.smallest.ai/atoms/v1/campaign

GET

/atoms/v1/campaign

1 from smallestai import SmallestAI
2 
3 client = SmallestAI(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.atoms.campaigns.retrieve_all_campaigns()

1 {
2   "status": true,
3   "data": {
4     "campaigns": [
5       {
6         "_id": "string",
7         "name": "string",
8         "description": "string",
9         "organization": "string",
10         "agent": {
11           "_id": "string",
12           "name": "string",
13           "workflowType": "string"
14         },
15         "audience": {
16           "_id": "string",
17           "name": "string"
18         },
19         "createdBy": "string",
20         "participantsCount": 1,
21         "status": "draft",
22         "maxRetries": 1,
23         "retryDelay": 1,
24         "retryAttempts": 1,
25         "scheduledAt": "2024-01-15T09:30:00Z",
26         "pausedAt": "2024-01-15T09:30:00Z",
27         "cancelledCallsCount": 1,
28         "createdAt": "2024-01-15T09:30:00Z",
29         "updatedAt": "2024-01-15T09:30:00Z"
30       }
31     ],
32     "pagination": {
33       "total": 1,
34       "page": 1,
35       "offset": 1,
36       "hasMore": true,
37       "totalPages": 1
38     },
39     "totalCampaignCount": 1
40   }
41 }

Get all campaigns for the authenticated organization.

Authentication

AuthorizationBearer

API key from the console ApiKey collection, sent as Bearer token. Also accepts session cookies for browser-based auth.

Query parameters

pageintegerOptionalDefaults to 1

Page number for pagination

offsetintegerOptionalDefaults to 5

Number of campaigns per page

statusenumOptional

Filter campaigns by status

searchstringOptional

Search campaigns by name

sortFieldenumOptionalDefaults to createdAt

Field to sort by

Allowed values:

sortOrderenumOptionalDefaults to desc

Sort direction

Allowed values:

Response

A list of campaigns

statusboolean

dataobject

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error