Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / CRM

List do-not-contact

Who outreach never writes to: email addresses, domains and LinkedIn profiles, the newest first, with why. A forgotten person's entry keeps no address, only its hash.

get/api/v1/do-not-contact

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 dnc list
MCP tooltroopy_list_do_not_contact
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

qstring

Part of an address or domain

At most 254 characters

Response

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

A 24-character id

kind*enum<string>

emaildomainlinkedin

label*string | null

The address, domain or profile; null once its person was forgotten

cause*enum<string>

manualunsubscribedbouncednot_interestedforgotten

reason*string
by*object

Who wrote it

3 properties
type*enum<string>

personagentapi

id*string
name*string
createdAt*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.