Obter a marca
RegistosGET /branding
The utility's effective brand and where each value comes from
Requires business:branding:read (utility owner and admin).
Devolve
200 Utility brand with sources
Mostrar atributos
nameshort_namelegal_namecopyrightWho the copyright line names (© <year> <copyright>). Empty means the legal name; when both are empty, clients show no copyright line rather than assume the product name.
supportMostrar atributos filhos
emailphoneurl
linksMostrar atributos filhos
websitetermsprivacy
colorsMostrar atributos filhos
brandbrand_foregroundaccent
logo_urlAbsolute path with a v hash, such as $PUBLIC_API/branding/assets/logo?v=…;
nullwhen unsetlogo_dark_urlicon_urlupdated_atreceipt_footertenantMostrar atributos filhos
idslug
platformMostrar atributos filhos
nameshort_nameicon_url
sourcesThe platform source keys plus receipt_footer.
Erros 403
Permissões business:branding:read · Funções: admin, owner
curl -X GET "$BUSINESS_API/branding" \
-H "Authorization: Bearer sk_test_..."
# Sem comando CLI equivalente; use cURL ou HTTP directo.
const res = await fetch("$BUSINESS_API/branding", {
method: "GET",
headers: {
Authorization: "Bearer sk_test_..."
}
});
const data = await res.json();
import requests
res = requests.get(
"$BUSINESS_API/branding",
headers={
"Authorization": "Bearer sk_test_..."
}
)
data = res.json()
req, _ := http.NewRequest("GET", "$BUSINESS_API/branding", nil)
req.Header.Set("Authorization", "Bearer sk_test_...")
resp, err := http.DefaultClient.Do(req)
{
"sources": {
"key": "custom"
},
"colors": {
"brand": "brand",
"brand_foreground": "brand foreground",
"accent": "accent"
},
"copyright": "copyright",
"icon_url": "https://example.org/",
"legal_name": "Ana Matsinhe",
"links": {
"website": "website",
"terms": "terms",
"privacy": "privacy"
},
"logo_dark_url": "https://example.org/",
"logo_url": "https://example.org/",
"name": "Ana Matsinhe",
"platform": {
"name": "Ana Matsinhe",
"short_name": "Ana Matsinhe",
"icon_url": "https://example.org/"
},
"receipt_footer": "receipt footer",
"short_name": "Ana Matsinhe",
"support": {
"email": "ana.matsinhe@example.org",
"phone": "+258841234567",
"url": "https://example.org/"
},
"tenant": {
"id": "ten_2sYXpy6D7kQ3lIa31QONH8u59Ia",
"slug": "slug"
},
"updated_at": "2026-11-19T09:30:00Z"
}