Retrieve the brand
The brand of the workspace: a link to each brand image, the primary and secondary fonts, and the background of the sign-in page.
Runs the real call on your workspace.
GET /branding
The brand of the workspace: a link to each brand image, the primary and secondary fonts, and the background of the sign-in page.
What the brand is
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"The brand is what the Appearance page of a workspace sets: four images, two fonts and the background of the sign-in page. A personal space carries none.
mark, the square icon, shows in the workspace switcher, and as the icon of the web app address once a logo is set.wordmark, the logo, shows at the top of the sidebar. It is what brands the web app address and, on a paid plan, the emails OpenEmail sends for the workspace, which carry it at the top and the foot and name the workspace in place of OpenEmail. Without a logo, both look like OpenEmail.wordmarkDark, the logo for dark mode, takes the place of the logo when the app shows dark.loginBackground, a photo, sits behind the sign-in page of the web app address.
The two fonts apply in the web app for everyone in the workspace, the primary font to its text and the secondary font to page headings, and the sign-in background shows on the web app address, whether or not a logo is set. Each font is one of these ids, or null for the default: system, arial, helvetica, verdana, tahoma, trebuchet-ms, georgia, times-new-roman, courier-new, dm-sans, inter, roboto, open-sans, lato, montserrat, poppins, nunito, work-sans, source-sans-3, ibm-plex-sans, merriweather, playfair-display, instrument-serif, jetbrains-mono, dm-mono, geist-mono.
Example
Needs settings:read.
curl "$OE/branding" -H "$AUTH"{ "object": "branding", "editable": true, "images": { "mark": "https://cdn-prod.openemail.uk/workspaces/icons/0199a1c2-7d4e-7a31-9b52-3c8e1f0a6d24.webp", "wordmark": "https://cdn-prod.openemail.uk/workspaces/wordmarks/0199a1c2-8b10-7e45-a2f1-6d9c3b7e0f58.webp", "wordmarkDark": null, "loginBackground": null }, "fonts": { "primary": "inter", "secondary": "georgia" }, "loginBackground": { "kind": "preset", "preset": "dusk", "color": null }}editable says whether this key may change the brand. It is false in a personal space, for a key without settings:write, and for a key limited to particular addresses or domains.
A loginBackground of kind image reads as null while no sign-in photo is uploaded.
