Saltar para a documentação
API

Obter a marca

A marca do espaço de trabalho: uma ligação para cada imagem da marca, o tipo de letra principal e o secundário, e o fundo da página de início de sessão.

GET/branding

Executa a chamada real no seu espaço de trabalho.

GET /branding

A marca do espaço de trabalho: uma ligação para cada imagem da marca, o tipo de letra principal e o secundário, e o fundo da página de início de sessão.

O que é a marca

shell
export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"

A marca é o que a página de Aspeto de um espaço de trabalho define: quatro imagens, dois tipos de letra e o fundo da página de início de sessão. Um espaço pessoal não tem nenhuma.

  • mark, o ícone quadrado, aparece no seletor de espaços de trabalho e, assim que há um logótipo, como ícone do endereço da app web.
  • wordmark, o logótipo, aparece no topo da barra lateral. É ele que dá a marca ao endereço da app web e, num plano pago, aos emails que a OpenEmail envia pelo espaço de trabalho, que o mostram no topo e no rodapé e nomeiam o espaço de trabalho em vez da OpenEmail. Sem logótipo, ambos têm o aspeto da OpenEmail.
  • wordmarkDark, o logótipo para o modo escuro, substitui o logótipo quando a app aparece escura.
  • loginBackground, uma foto, fica por trás da página de início de sessão do endereço da app web.

Os dois tipos de letra aplicam-se na app web a todos no espaço de trabalho, o principal ao texto e o secundário aos títulos das páginas, e o fundo de início de sessão aparece no endereço da app web, haja ou não um logótipo. Cada tipo de letra é um destes ids, ou null para o predefinido: 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.

Exemplo

Requer settings:read.

curl
curl "$OE/branding" -H "$AUTH"
Resposta
{  "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 indica se esta chave pode alterar a marca. É false num espaço pessoal, para uma chave sem settings:write e para uma chave limitada a determinados endereços ou domínios.

Um loginBackground do tipo image lê-se como null enquanto não houver uma foto de início de sessão carregada.

A sua caixa de entrada,
nos seus termos.

Infraestrutura de email para empresas, IA, agentes e correio pessoal. Feita para escala, privacidade e controlo. Tudo o que o email devia ter tido desde o primeiro dia.

© 2026 OpenEmail. Todos os direitos reservados.