API reference / Email
List mailboxes
The mailboxes this workspace sends outreach from: each one's provider, pace and status, its domain's SPF, DKIM and DMARC as last checked, and its last test send. Never their sign-ins.
/api/v1/mailboxesOther ways to call it
troopy mailboxes listtroopy_list_mailboxesResponse
200 · application/jsondata*array<object>15 properties
id*stringA 24-character id
address*stringname*stringThe From name people see
signature*stringprovider*enum<string>googlemicrosoftzohozoho_euzoho_infastmail
providerName*stringstatus*enum<string>activepauseddisconnected
why*string | nullWhy it isn't active
dailyCap*integerThe most it sends a day, once ramped up
gapMinutes*integerMinutes between its sends, at least
readAll*booleanRead all: Troopy keeps every new mail of its inbox for 30 days, and everyone in the workspace reads it. For a shared address.
dns*object | nullIts domain's SPF, DKIM and DMARC as last checked: a campaign needs SPF or DKIM
4 properties
spf*enum<string>pass: one SPF record naming its provider; other: one that doesn't name it directly; many: more than one
passothermissingmany
dkim*enum<string>found at its provider's usual selector; unknown: not there
foundunknown
dmarc*object | null1 properties
policy*stringcheckedAt*stringISO 8601 date and time
test*object | nullIts last test send
4 properties
to*stringThe teammate's inbox it went to
sentAt*stringISO 8601 date and time
receivedAt*string | nullverdicts*object | nullWhat the receiving side said: pass, fail or gray each
4 properties
spf*string | nulldkim*string | nulldmarc*string | nullspam*string | nullcreatedBy*objectWho wrote it
3 properties
type*enum<string>personagentapi
id*stringname*stringcreatedAt*stringISO 8601 date and time