API referenceBrand Kit
Get the brand kit
The workspace’s brand kit with its draft (the latest version) and which version is published; the first read makes it with the defaults, as a draft.
GET
The workspace’s brand kit with its draft (the latest version) and which version is published; the first read makes it with the defaults, as a draft.
apiKey readheader
AuthorizationBearer <token>A workspace API key (pf_…), created under Developers → API keys.
Scope: read
OK
application/json- response
id*stringFormat
uuidkind*stringname*stringstatus*stringValue in
"draft""published""archived"draftVersionId*stringFormat
uuidpublishedVersionId*|Format
uuidhasUnpublishedChanges*booleancreatedAt*stringFormat
date-timeupdatedAt*stringFormat
date-timearchivedAt*|Format
date-timedraft*curl -X GET 'https://api.postforge.dev/v1/brand-kit'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "kind": "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", "draft": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "definitionId": "058563fe-6949-46e9-9fb3-06a0e3a11f6a", "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", "definition": { "logo": { "assetId": "9179b887-04ef-4ce5-ab3a-b5bbd39ea3c8", "darkAssetId": "7f2d7a5c-c164-4dc5-9d6f-b92860b4df8d" }, "colors": { "roles": { "background": "string", "surface": "string", "text": "string", "muted": "string", "primary": "string", "on_primary": "string", "border": "string" }, "custom": [ { "key": "string", "label": "string", "value": "string" } ] }, "fonts": { "heading": { "source": "system", "family": "Arial" }, "body": { "source": "system", "family": "Arial" }, "custom": [ { "key": "string", "label": "string", "font": { "source": "system", "family": "Arial" } } ] }, "text": { "fontSize": 12, "lineHeight": 1 }, "headings": { "fontWeight": 400, "lineHeight": 1, "sizes": { "h1": 16, "h2": 14, "h3": 12 } }, "links": { "color": "string", "underline": true }, "buttons": [ { "key": "string", "label": "string", "background": "string", "color": "string", "border": { "color": "string", "width": 1 }, "font": "string", "fontSize": 12, "fontWeight": 400, "radius": 0, "paddingY": 4, "paddingX": 8 } ], "defaultButton": "string", "footer": { "companyName": "string", "postalAddress": "string", "note": { "property1": "string", "property2": "string" } }, "socials": { "links": [ { "network": "instagram", "url": "http://example.com" } ], "iconStyle": "color" } } }}Restore a object type version POST
Saves a copy of an older version as the new draft; publish it to use it.
Update the brand kit PATCH
Saves a new draft version on top of `baseVersionId`, which must be the current draft (409 `version_stale` otherwise). The published version doesn’t change until it’s published.