API reference / Outreach
Get a campaign
One outreach campaign, with its counts.
/api/v1/campaigns/{id}Other ways to call it
troopy campaigns gettroopy_get_campaignPath parameters
id*stringA 24-character id
Response
200 · application/jsondata*object14 properties
id*stringA 24-character id
name*stringlist*object | nullThe list of people it is for
2 properties
id*stringA 24-character id
name*stringwhere*array<object>3 properties
column*stringop*enum<string>isis_notcontainsgtltemptynot_empty
valuestring | number | boolean | nullsteps*array<object>6 properties
kind*"email"wait*integerwrite*enum<string>fixed: the body is the email, with variables filled in for each lead. ai: a teammate writes the email for each lead from the brief
fixedai
brief*string | nullsubject*string | nullbody*string | nullmailboxes*array<string>The mailboxes it sends from
window*object4 properties
days*array<integer>start*integerend*integertimezone*stringstatus*enum<string>draftactivepauseddone
stats*object7 properties
enrolled*integeractive*integerreplied*integerbounced*integerunsubscribed*integersent*integerreview*integerDrafts waiting for a person
writer*objectThe emails that a teammate writes for each lead
2 properties
busy*booleanA teammate writes emails of it now
error*string | nullWhy its emails could not be written lately. The teammate tries again after 10 minutes
autopilot*object | nullAn owner's or admin's grant to send without a person approving each email; null when never granted
7 properties
on*booleanIn force now
until*stringISO 8601 date and time
dailyCap*integergrantedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringgrantedAt*stringISO 8601 date and time
endedAt*string | nullwhy*string | nullWhy it ended
createdBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time
updatedAt*stringISO 8601 date and time