API reference / Troop
Get a teammate's email
One email a teammate received, with its words: every code and link masked, like [code 1] and [link 2: canva.com "Verify email"].
/api/v1/agents/{handle}/inbox/{id}Other ways to call it
troopy agents emailtroopy_get_teammate_emailPath parameters
handle*stringThe teammate's handle, like chief
At most 40 characters
id*stringA 24-character id
Response
200 · application/jsondata*object14 properties
id*stringA 24-character id
direction*enum<string>in for an email that came, out for one that the address sent
inout
from*stringThe sender's address
fromName*stringsubject*stringCodes in it masked, like [code 1]
receivedAt*stringISO 8601 date and time
checked*booleanThe sender's domain passed DMARC: the one sign it is who it says
spam*booleanSES called it spam: the teammate doesn't see it
codes*integerHow many codes it carries. Never shown over the API: the teammate types them by reference
links*array<object>Its links' sites and words, never their addresses
3 properties
n*integersite*stringlabel*stringto*array<string>A sent email: the addresses that it went to
status*enum<string> | nullA sent email: whether it went. unknown when it possibly went: Troopy does not send it again
sendingsentfailedunknown
error*string | nullA sent email that did not go, or possibly did not: why
textstringOne email's words, every code and link masked