Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Outreach

List replies

What leads wrote back to campaigns' emails, across mailboxes, the newest first: their words without what they quoted. A reply stops its lead's sequence at once, and one whose first line says no, stop, unsubscribe or remove me unsubscribes them. Automatic replies and delivery reports aren't listed: they pause or bounce the lead.

get/api/v1/replies

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy replies list
MCP tooltroopy_list_replies
Rate limit120 calls in 60 seconds, for each key

Query parameters

pageinteger

1-based page number

Default 1 · At least 1

limitinteger

Items per page, at most 100

Default 20 · At least 1 · At most 100

idstring

Only the reply with this id

campaignstring

Only this campaign's

sortenum<string>

Only those sorted so, or not sorted yet

interestedquestionnot_nownot_interestedout_of_officeunsubscribewrong_personunsorted

Response

200 · application/json
data*array<object>
10 properties
id*string

A 24-character id

campaign*object | null
2 properties
id*string

A 24-character id

name*string
lead*object
5 properties
enrollment*string

A 24-character id

person*string

A 24-character id

email*string
name*string | null
status*enum<string>

activepausedrepliedbouncedunsubscribeddonestopped

mailbox*string

The address it came to

subject*string
body*string

Their words, without what they quoted, at most 8,000 characters

sort*enum<string> | null

What it says; null until someone sorts it

interestedquestionnot_nownot_interestedout_of_officeunsubscribewrong_person

sortedBy*object | null
3 properties
type*enum<string>

personagentapi

id*string
name*string
summary*string | null
receivedAt*string

ISO 8601 date and time

pagination*object
4 properties
page*integer
limit*integer
total*integer
pages*integer

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.