Mail API reference

Mail API · Brand

get/v1/workspaces/{workspace_id}/brandAuth

Get the resolved brand tokens for the workspace. Always returns a complete object, with platform defaults filling in any unset fields.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Response · 200

resolved*object

Fully-resolved tokens every render uses. The frontend reads this for previews so what the editor shows == what recipients get.

raw*object

User-set values only (null when the workspace has never customised). Null fields signal "not customised — falling through to default".

Example

Request

GET https://api.mail.productcraft.co/v1/workspaces/{workspace_id}/brand
Authorization: Bearer YOUR_TOKEN

Response

{
  "resolved": {},
  "raw": {}
}