List messages
Every email the workspace sent or meant to send, one per recipient, newest first, a page at a time by cursor (`nextCursor` until the last page): who it went to, what became of it and when it was opened and clicked. `from` and `to` keep it to when sends started: only those months are read.
Every email the workspace sent or meant to send, one per recipient, newest first, a page at a time by cursor (nextCursor until the last page): who it went to, what became of it and when it was opened and clicked. from and to keep it to when sends started: only those months are read.
apiKey readAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
cursor?stringThe previous page’s nextCursor; omit for the first page
length <= 200pageSize?numberOne of 10, 25, 50, 100
25profileId?stringOnly the emails sent to this profile
uuidsendId?stringOnly the emails of this send
uuidstatus?stringComma-separated, any of: queued, sent, failed, skipped, cancelled
from?stringEmails whose send started from this time (inclusive)
date-timeto?stringEmails whose send started before this time (exclusive)
date-timeOK
application/json- response
items*array<>pageSize*integernextCursor*string|nullcurl -X GET 'https://api.postforge.dev/v1/messages'{ "items": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "sendId": "98079182-77f0-4075-97da-b6e925fc22cb", "source": "test", "profileId": "faebe71b-2bf8-4bdb-9b67-258e4d6aa00a", "toAddress": "string", "fromHeader": "string", "replyTo": "string", "locale": "string", "emailProviderId": "683bf648-54ce-4fc9-9f81-2da7d42459c3", "providerMessageId": "string", "status": "queued", "failureReason": "rejected", "failureDetail": "string", "skipReason": "suppressed", "queuedAt": "2019-08-24T14:15:22Z", "sentAt": "2019-08-24T14:15:22Z", "deliveredAt": "2019-08-24T14:15:22Z", "delayedAt": "2019-08-24T14:15:22Z", "bouncedAt": "2019-08-24T14:15:22Z", "bounceKind": "hard", "bounceReason": "unknown_address", "bounceDetail": "string", "complainedAt": "2019-08-24T14:15:22Z", "firstOpenedAt": "2019-08-24T14:15:22Z", "lastOpenedAt": "2019-08-24T14:15:22Z", "machineOpenedAt": "2019-08-24T14:15:22Z", "firstClickedAt": "2019-08-24T14:15:22Z", "lastClickedAt": "2019-08-24T14:15:22Z", "machineClickedAt": "2019-08-24T14:15:22Z", "erasedAt": "2019-08-24T14:15:22Z" } ], "pageSize": 0, "nextCursor": "string"}