Campaigns
Authorization
bearerAuth AuthorizationBearer <token>
An API key created under Settings → API & Webhooks.
In: header
Query Parameters
limit?integer
Page size, 1–100.
Range
1 <= value <= 100Default
50offset?integer
Number of records to skip.
Range
0 <= valueDefault
0Response Body
application/json
application/json
curl -X GET "https://example.com/campaigns"{ "data": [ { "id": "string", "name": "string", "status": "draft", "stats": { "total": 0, "done": 0, "failed": 0 }, "aiInterestEnabled": true, "linkedinAccountIds": [ "string" ], "excludeListIds": [ "string" ], "excludeOtherCampaigns": true, "excludeOtherSenders": true, "excludeSameSenderOtherCampaigns": true, "schedule": { "startDate": "2019-08-24T14:15:22Z", "endDate": "2019-08-24T14:15:22Z", "timezone": "string", "activeHours": { "from": "string", "to": "string" }, "activeDays": [ 0 ] }, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z" } ], "paging": { "limit": 0, "offset": 0 }}Get a campaign GET
Returns the campaign including its outreach `sequence` (the tree of steps).
Rebalance a sender's leads POST
Move a paused or failed sender's not-yet-contacted leads in this campaign onto the campaign's other available senders, evenly. Leads the sender already contacted stay pinned to it. Returns how many leads `moved` and how many `receivers` took them; `receivers: 0` means no other sender was available and nothing moved (still `200`). `422` when the account is not in the campaign's sender pool.