API reference / Outreach
List a campaign's emails
A campaign's emails, the soonest due first: the drafts waiting for a person unless you ask for another status.
/api/v1/campaigns/{id}/emailsOther ways to call it
troopy campaigns emailstroopy_list_campaign_emailsPath parameters
id*stringA 24-character id
Query parameters
pageinteger1-based page number
Default 1 · At least 1
limitintegerItems per page, at most 100
Default 20 · At least 1 · At most 100
statusenum<string>draftapprovedsendingsentunknownfailedskippedcanceledreceived
Response
200 · application/jsondata*array<object>17 properties
id*stringA 24-character id
lead*object4 properties
enrollment*stringA 24-character id
email*stringname*string | nullstatus*enum<string>activepausedrepliedbouncedunsubscribeddonestopped
step*integerIts step, from 0
subject*stringbody*stringflags*array<string>What a person should look at first: a flagged email always waits for one
status*enum<string>draftapprovedsendingsentunknownfailedskippedcanceledreceived
dueAt*string | nullsentAt*string | nullwrittenBy*enum<string>templatepersonteammate
teammate*object | nullThe teammate that wrote it
2 properties
name*stringhandle*stringnote*string | nullThe line of the teammate for the person who reviews it: the detail it starts with, and where that comes from
used*array<object>What the teammate took from the lead's material, each with the words it took. Troopy checked each quote against its source
3 properties
source*stringurl*string | nullquote*stringrewriting*booleanA teammate writes it again now, as a person asked
approvedBy*object | null3 properties
type*enum<string>personagentapi
id*stringname*stringautopilot*booleanApproved by the campaign's Autopilot, in the name of whoever granted it
error*string | nullWhy it hasn't gone, or may not have, or why it couldn't be rewritten
pagination*object4 properties
page*integerlimit*integertotal*integerpages*integer