API referenceCampaigns
List a campaign’s recipients
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.
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.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringMatch
^(camp)_[0-9A-Za-z]{8}$page?integerStarts at 1
Range
1 <= valueDefault
1pageSize?numberOne of 10, 25, 50, 100
Default
25q?stringSearch
Length
1 <= length <= 200filter?stringDefault
"all"Value in
"all""opened""clicked""ordered""bounced""unsubscribed""not_sent"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integercurl -X GET 'https://api.postforge.dev/v1/campaigns/string/recipients'{ "items": [ { "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85", "address": "string", "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a", "name": "string", "status": "delivered", "skipReason": "suppressed", "firstOpenedAt": "2019-08-24T14:15:22Z", "firstClickedAt": "2019-08-24T14:15:22Z", "ordered": [ { "currency": "string", "amount": 0 } ] } ], "total": 0, "page": 0, "pageSize": 0}