List campaigns

GET

/campaigns

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Query Params

Header Params

Responses

🟢200

application/json

List of campaigns

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET '/campaigns?page&limit' \
--header 'x-workspace;' \
--header 'X-API-Key: <api-key>'

Response Example

{
    "data": [
        {
            "_id": "64a1b2c3d4e5f6a7b8c9d0e1",
            "name": "string",
            "status": "Active",
            "emailAccounts": [
                "64a1b2c3d4e5f6a7b8c9d0e1"
            ],
            "tags": [
                "string"
            ],
            "dailyLimit": 0,
            "schedule": {
                "timezone": "America/New_York",
                "days": [
                    0
                ],
                "startHour": 0,
                "endHour": 0
            },
            "createdAt": "2019-08-24T14:15:22.123Z",
            "updatedAt": "2019-08-24T14:15:22.123Z"
        }
    ],
    "pagination": {
        "page": 0,
        "limit": 0,
        "total": 0,
        "totalPages": 0
    }
}

Modified at 2026-04-08 21:41:20

Create a campaign