The brand this request sees

GET

/api/v1/branding

curl --request GET \
  --url http://localhost:3000/api/v1/branding

What the product is called and how it looks: the organization whose domain this is, else whoever is signed in or holds the key, else the only organization, else the server’s (BRAND_*). An organization sets its own with PATCH /api/v1/settings/branding.

No key needed.

Responses

200

The brand

Media typeapplication/json

object

data

required

object

name

required

What the product is called here

string

tagline

required

string | null

logo

required

A URL on this host

string | null

icon

required

A URL on this host, square

string | null

accent

required

string | null

emailFooter

required

string | null

custom

required

Anything differs from the product’s own look

boolean

Example^generated

{
  "data": {
    "name": "example",
    "tagline": "example",
    "logo": "example",
    "icon": "example",
    "accent": "example",
    "emailFooter": "example",
    "custom": true
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}