Skip to content
calternal docs

Get Appearance settings

GET
/api/v1/appearance
curl --request GET \
  --url https://example.com/api/v1/appearance \
  --header 'Authorization: Bearer <token>'

Returns the Appearance settings. It requires a signed-in User with the data scope. It can return 401 if the session is missing or expired and 403 if access is denied. Route: /api/v1/appearance. Inputs: . Safe reads can use bounded retries.

Authorizations

Section titled “Authorizations”

Responses

Section titled “Responses”

200

Section titled “200”
Media typeapplication/json

Readable appearance state and instance capabilities.

object
auto_scheme
One of:

None means no Installation has migrated a colour scheme yet.

object
mode
required

A persistent colour scheme choice.

string
Allowed values: system auto light dark
background
required

The old light/dark pair, present only until the client writes its family-keyed migration. Kept as a read bridge for one release.

object
dark
One of:
One of:

Use the selected theme’s static mesh gradient.

object
kind
required
string
Allowed values: theme
light
required
One of:

Use the selected theme’s static mesh gradient.

object
kind
required
string
Allowed values: theme
backgrounds
required

Background choices by theme family. A missing family uses its theme.

object
key
additional properties

The two backgrounds saved for a family.

object
dark
required
One of:

Use the selected theme’s static mesh gradient.

object
kind
required
string
Allowed values: theme
light
required
One of:

Use the selected theme’s static mesh gradient.

object
kind
required
string
Allowed values: theme
capabilities
required

Feature availability for optional appearance sources.

object
unsplash_available
required
boolean
fonts
required

The three type roles that a User can choose in Settings → Appearance.

object
display
required

Display face ids are stable settings values, not font file names.

string
Allowed values: bricolage-grotesque newsreader fraunces literata source-serif-4 roboto-serif playfair-display
mono
required

Mono face ids are stable settings values, not font file names.

string
Allowed values: maple-mono spline-sans-mono jetbrains-mono system
ui
required

UI face ids are stable settings values, not font file names.

string
Allowed values: google-sans inter system
Example
{
  "auto_scheme": {
    "mode": "system"
  },
  "background": {
    "dark": {
      "kind": "theme"
    },
    "light": {
      "kind": "theme"
    }
  },
  "backgrounds": {
    "additionalProperty": {
      "dark": {
        "kind": "theme"
      },
      "light": {
        "kind": "theme"
      }
    }
  },
  "fonts": {
    "display": "bricolage-grotesque",
    "mono": "maple-mono",
    "ui": "google-sans"
  }
}

401

Section titled “401”
Media typeapplication/json

The standard API error response: { "error": { ... } }.

object
error
required

Error details.

object
code
required

Stable machine-readable code.

string
Allowed values: bad_request unauthorized forbidden not_found conflict name_conflict_case name_too_long push_endpoint_rejected too_many_requests internal service_unavailable
details
One of:

Optional field or operation details.

object
key
additional properties
string
message
required

Safe text for logs or a user-facing error message.

string
Example
{
  "error": {
    "code": "bad_request"
  }
}