Campaigns
List campaigns
GET
/campaignsEvery campaign, with how many people are in each state.
Try itSend a real request with your API key
Answer
200 OK Campaigns.
dataarray of CampaignRequiredEach item
idstringRequiredCampaign ID.
namestringRequiredstatusstringRequireddraft: not launched. active: running. paused: stopped by the owner. completed: finished. One of
draft,active,paused,completed.archivedbooleanRequiredArchived in Salesteam: hidden from the Campaigns list. Resuming brings it back.
listIdstring or nullRequiredThe lead list this campaign takes people from.
stepsintegerRequiredHow many steps the sequence has.
audienceintegerRequiredPeople in the campaign’s list.
leadsobjectRequiredInside it
totalintegerRequiredactiveintegerRequiredwaitingForAcceptanceintegerRequiredpausedintegerRequiredfinishedintegerRequiredrepliedintegerRequired
createdAtstring · date-timeRequiredupdatedAtstring · date-timeRequired
nextCursorstring or nullRequiredPass as
cursorfor the next page; null on the last page.
Errors
- 401 Unauthorized
unauthorized - 429 Too many requests
rate_limited - 500 Server error
server_error
Every error has the same shape. See Errors.