GET
/
campaign
Get All Campaigns
curl --request GET \
  --url https://api.sendx.io/api/v1/rest/campaign \
  --header 'X-Team-ApiKey: <api-key>'
[
  {
    "id": "campaign123xyz",
    "name": "New Year Promotion",
    "trackReply": false,
    "subject": "New Year Promotion",
    "status": 1,
    "scheduleType": 0,
    "scheduleCondition": "2024-12-30",
    "timeCondition": "9:00 AM",
    "timezone": "America/New_York",
    "preferredTimeCondition": "Send during work hours",
    "preferredTimezone": "America/Los_Angeles",
    "strategy": "Batch sending",
    "sendInContactsTimezone": true,
    "smartSend": false,
    "isArchived": false,
    "sender": "marketing@company.com",
    "campaignScreenshotUrl": "https://example.com/screenshot.png",
    "includedSegments": [
      "VIP Customers",
      "New Subscribers"
    ],
    "includedLists": [
      "List 1",
      "List 2"
    ],
    "includedTags": [
      "Tag 1",
      "Tag 2"
    ],
    "excludedSegments": [
      "Unsubscribed Users",
      "Bounced Emails"
    ],
    "excludedLists": [
      "List 3",
      "List 4"
    ],
    "excludedTags": [
      "Tag 3",
      "Tag 4"
    ]
  }
]

Authorizations

X-Team-ApiKey
string
header
required

Query Parameters

offset
integer
default:0

Offset for pagination

limit
integer
default:20

Limit for pagination

Search term to filter campaigns

Response

200
application/json

Retrieved campaigns successfully.

The response is of type object[].