API referenceEmails
Get a email version
GET
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
id*stringMatch
^(email)_[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/emails/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": { "locales": [ "string" ], "settings": { "width": 320, "background": { "token": "string" }, "brand": { "colors": { "property1": "string", "property2": "string" }, "text": { "font": "string", "fontSize": 12, "lineHeight": 1, "mobile": { "fontSize": 12, "lineHeight": 1 } }, "headings": { "h1": { "font": "string", "fontSize": 16, "lineHeight": 1, "mobile": { "fontSize": 16, "lineHeight": 1 }, "fontWeight": 400 }, "h2": { "font": "string", "fontSize": 14, "lineHeight": 1, "mobile": { "fontSize": 14, "lineHeight": 1 }, "fontWeight": 400 }, "h3": { "font": "string", "fontSize": 12, "lineHeight": 1, "mobile": { "fontSize": 12, "lineHeight": 1 }, "fontWeight": 400 } }, "links": { "color": "string", "underline": true }, "buttons": { "property1": { "background": "string", "color": "string", "border": { "color": "string", "width": 1 }, "font": "string", "fontSize": 12, "fontWeight": 400, "radius": 0, "paddingY": 4, "paddingX": 8, "mobile": { "fontSize": 12, "paddingY": 4, "paddingX": 8 } }, "property2": { "background": "string", "color": "string", "border": { "color": "string", "width": 1 }, "font": "string", "fontSize": 12, "fontWeight": 400, "radius": 0, "paddingY": 4, "paddingX": 8, "mobile": { "fontSize": 12, "paddingY": 4, "paddingX": 8 } } } } }, "sections": [ { "id": "string", "name": "string", "visibility": { "locales": [ "string" ], "hideOn": "mobile" }, "repeat": { "over": "string", "as": "string", "limit": 1 }, "type": "section", "background": { "token": "string" }, "contentBackground": { "token": "string" }, "backgroundImage": { "prop": "string" }, "padding": [ 0, 0, 0, 0 ], "mobile": { "padding": [ 0, 0, 0, 0 ], "margin": [ 0, 0, 0, 0 ], "labelPadding": [ 0, 0 ], "fontSize": 0, "lineHeight": 0.8, "align": "left", "width": "full", "height": 0 }, "children": [ { "id": "string", "name": "string", "visibility": { "locales": [ "string" ], "hideOn": "mobile" }, "repeat": { "over": "string", "as": "string", "limit": 1 }, "type": "heading", "level": 1, "text": { "prop": "string" }, "style": { "font": "string", "fontSize": 0, "lineHeight": 0.8, "fontWeight": 400, "color": { "token": "string" }, "align": "left" }, "background": { "token": "string" }, "padding": [ 0, 0, 0, 0 ], "margin": [ 0, 0, 0, 0 ], "mobile": { "padding": [ 0, 0, 0, 0 ], "margin": [ 0, 0, 0, 0 ], "labelPadding": [ 0, 0 ], "fontSize": 0, "lineHeight": 0.8, "align": "left", "width": "full", "height": 0 } } ] } ], "subject": { "property1": "string", "property2": "string" }, "preheader": { "property1": "string", "property2": "string" }, "everyoneElse": "string", "templateId": "string" }}