API referenceCampaigns
List the orders a campaign earned
Newest first; `q` searches the order number, the buyer’s name and address.
GET
Newest first; q searches the order number, the buyer’s name and address.
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 <= 200OK
application/json- response
items*array<>total*integerpage*integerpageSize*integercurl -X GET 'https://api.postforge.dev/v1/campaigns/string/orders'{ "items": [ { "orderId": "b3e1eced-f2bd-4d8c-9765-fbc9d1d222d5", "number": "string", "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a", "customerName": "string", "email": "string", "placedAt": "2019-08-24T14:15:22Z", "total": { "currency": "string", "amount": 0 }, "touch": "click", "touchedAt": "2019-08-24T14:15:22Z" } ], "total": 0, "page": 0, "pageSize": 0}What a campaign’s orders came to GET
The orders attributed to its latest send (D180): revenue, orders and average per currency, buyers, new customers, items sold and the bestselling products, with the attribution windows they were decided with.
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.