List automations
Archived ones only when the status filter asks for them.
Archived ones only when the status filter asks for them.
apiKey readAuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
page?integerStarts at 1
1 <= value1pageSize?numberOne of 10, 25, 50, 100
25q?stringSearch
1 <= length <= 200status?stringComma-separated, any of: draft, published, archived
sort?stringOne of name, createdAt, updatedAt; prefix with - for descending
"-updatedAt""name""-name""createdAt""-createdAt""updatedAt""-updatedAt"OK
application/json- response
items*array<>total*integerpage*integerpageSize*integercurl -X GET 'https://api.postforge.dev/v1/automations'{ "items": [ { "id": "string", "kind": "string", "name": "string", "folder": { "id": "string", "name": "string" }, "status": "draft", "draftVersionId": "e7fc80a1-b65e-482e-8fcd-f6c647b4104b", "publishedVersionId": "9786f1b1-ef7e-4f6a-94c4-c8eb67e924eb", "hasUnpublishedChanges": true, "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "archivedAt": "2019-08-24T14:15:22Z", "trigger": { "type": "event", "event": "string", "where": { "type": "and", "conditions": [ null ] } }, "state": { "status": "on", "changedAt": "2019-08-24T14:15:22Z", "active": 0, "unsavedChanges": true } } ], "total": 0, "page": 0, "pageSize": 0}Send a test of an email POST
Sends the email as it is now, in one locale, to up to 5 addresses from one of the workspace’s senders, filled in like the preview. The subject is its own, after “[Test]”. Refused before anything is sent when it has gaps in the locale (a subject among them) or the sender can’t send; consent isn’t asked for a test.
Create a automation POST
Its first version is the draft; it goes into use by its own action.