API reference / Email
Get an email
One email with its words. The mail of a teammate needs agents:read too, and has every code and link masked. Owners and admins reveal a code or a link in the app.
/api/v1/emails/{id}Other ways to call it
troopy emails gettroopy_get_emailPath parameters
id*stringThe id of an email. c- is an email of a campaign or a reply to it. d- is an email that a person wrote, or an answer to it. t- is the mail of a teammate
Response
200 · application/jsondata*object20 properties
id*stringThe id of an email. c- is an email of a campaign or a reply to it. d- is an email that a person wrote, or an answer to it. t- is the mail of a teammate
kind*enum<string>campaignreplydirectteammate
status*enum<string>failed: an email of a person that did not go. unknown: one that possibly went, so Troopy does not send it again
receivedsentscheduleddraftfailedunknown
box*object | nullThe mailbox, or the address of the teammate, that it came to or went from. Null for a draft with no mailbox yet
2 properties
id*stringThe id of a box. m- is a mailbox of the business. t- is the own address of a teammate
address*stringparty*objectWho it is from, for a received email. Who it is to, for the rest
2 properties
name*string | nullemail*stringsubject*stringpreview*stringThe start of its words, at most 160 characters
at*stringWhen it came or went. For a scheduled email or a draft, when it is due
campaign*object | null2 properties
id*stringA 24-character id
name*stringteammate*object | null2 properties
handle*stringname*stringspam*booleanread*booleanFalse for a received email that no person opened. True for every other email
labels*array<string>The labels that people put on it
sort*enum<string> | nullFor a reply: what it says. Null until someone sorts it, and for every other email
interestedquestionnot_nownot_interestedout_of_officeunsubscribewrong_person
bodystringOnly for one email: its words. The mail of a teammate has every code and link masked
maskedobjectOnly for one email of a teammate: how many codes and links are masked in its words
2 properties
codes*integerlinks*integererrorstringOnly for one email of a person: what the mail server or a delivery report said, when not every address got the email
recipientsarray<string>Only for an email of a person to more than one address: every address that it went to
attachmentsarray<object>The files that went with an email of a person: their names and sizes. Troopy does not keep the files
3 properties
name*stringtype*stringsize*integerIn bytes
threadarray<object>Only for one email: every email between the business and this address, the oldest first, with its words
19 properties
id*stringThe id of an email. c- is an email of a campaign or a reply to it. d- is an email that a person wrote, or an answer to it. t- is the mail of a teammate
kind*enum<string>campaignreplydirectteammate
status*enum<string>failed: an email of a person that did not go. unknown: one that possibly went, so Troopy does not send it again
receivedsentscheduleddraftfailedunknown
box*object | nullThe mailbox, or the address of the teammate, that it came to or went from. Null for a draft with no mailbox yet
2 properties
id*stringThe id of a box. m- is a mailbox of the business. t- is the own address of a teammate
address*stringparty*objectWho it is from, for a received email. Who it is to, for the rest
2 properties
name*string | nullemail*stringsubject*stringpreview*stringThe start of its words, at most 160 characters
at*stringWhen it came or went. For a scheduled email or a draft, when it is due
campaign*object | null2 properties
id*stringA 24-character id
name*stringteammate*object | null2 properties
handle*stringname*stringspam*booleanread*booleanFalse for a received email that no person opened. True for every other email
labels*array<string>The labels that people put on it
sort*enum<string> | nullFor a reply: what it says. Null until someone sorts it, and for every other email
interestedquestionnot_nownot_interestedout_of_officeunsubscribewrong_person
bodystringOnly for one email: its words. The mail of a teammate has every code and link masked
maskedobjectOnly for one email of a teammate: how many codes and links are masked in its words
2 properties
codes*integerlinks*integererrorstringOnly for one email of a person: what the mail server or a delivery report said, when not every address got the email
recipientsarray<string>Only for an email of a person to more than one address: every address that it went to
attachmentsarray<object>The files that went with an email of a person: their names and sizes. Troopy does not keep the files
3 properties
name*stringtype*stringsize*integerIn bytes