API referenceCampaigns
How a campaign’s emails were delivered
Bounces by reason and kind, delivery per mailbox provider (from each address’s domain), what wasn’t sent and why, and how people unsubscribed.
GET
Bounces by reason and kind, delivery per mailbox provider (from each address’s domain), what wasn’t sent and why, and how people unsubscribed.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringMatch
^(camp)_[0-9A-Za-z]{8}$OK
application/json- response
bouncesByReason*array<>byProvider*array<>notSent*array<>unsubscribedBy*curl -X GET 'https://api.postforge.dev/v1/campaigns/string/deliverability'{ "bouncesByReason": [ { "reason": "unknown_address", "kind": "hard", "count": 0 } ], "byProvider": [ { "provider": "gmail", "sent": 0, "delivered": 0, "bounced": 0, "complained": 0 } ], "notSent": [ { "reason": "suppressed", "count": 0 } ], "unsubscribedBy": { "link": 0, "inbox": 0 }}List a campaign’s recipients GET
Everyone its latest send was for, with what became of their email and what they did: opened, clicked, ordered. `filter` narrows it; `q` searches the address and name.
List a campaign’s bounces GET
Every bounce of its latest send, newest first: the address, hard or soft, the reason and the receiving server’s words, and whether the address is suppressed now.