API referenceCampaigns
Get a campaign version
GET
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringMatch
^(camp)_[0-9A-Za-z]{8}$versionId*stringFormat
uuidOK
application/json- response
id*stringFormat
uuiddefinitionId*stringMatch
^(tmpl|comp|brand|otype|seg|trait|camp|auto)_[0-9A-Za-z]{8}$parentVersionId*|Format
uuidorigin*stringValue in
"edit""restore""proposal"schemaVersion*integerauthor*createdAt*stringFormat
date-timeopenedAt*stringFormat
date-timedefinition*curl -X GET 'https://api.postforge.dev/v1/campaigns/string/versions/497f6eca-6276-4993-bfeb-53cbbbba6f08'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "definitionId": "string", "parentVersionId": "abf80970-9686-419e-bc00-5ddcccc33ba6", "origin": "edit", "schemaVersion": 0, "author": { "type": "user", "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string" }, "createdAt": "2019-08-24T14:15:22Z", "openedAt": "2019-08-24T14:15:22Z", "definition": { "audience": { "include": [ { "type": "list", "listId": "string" } ], "exclude": [ { "type": "list", "listId": "string" } ] }, "emailId": "string", "senderId": "6b2f63ba-164c-48c9-87b1-690cee2b3da3", "replyTo": "user@example.com", "smartSending": { "enabled": true, "hours": 1 }, "utm": { "enabled": true, "source": "string", "medium": "string", "campaign": "string", "content": "string" }, "linkParameters": [ { "name": "string", "value": { "kind": "fixed", "text": "string" } } ] }}