# Retrieve branding

<div class="api-op" data-api-operation>
<div class="api-op__main">

<p class="api-endpoint"><span class="method method-get">GET</span> <code>/v1/branding</code></p>

<dl class="api-facts"><div><dt>Scope</dt><dd><code>branding:read</code></dd></div><div><dt>Auth</dt><dd>Secret key (<code>sk_…</code>)</dd></div><div><dt>Since</dt><dd>1.0</dd></div></dl>

## Headers

<ul class="api-fields">
<li class="api-field">
<p class="api-field__head"><code class="api-field__name">OhAuthCat-Version</code> <span class="api-field__type">string</span></p>
Minor version; defaults to the environment's pin.
</li>
</ul>

## Responses

<ul class="api-responses">
<li class="api-response"><span class="api-status api-status--ok">200</span> <span>OK <span class="api-field__type">Branding</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">400</span> <span>Invalid request. Codes: <a href="/errors/parameter_invalid/">parameter_invalid</a>, <a href="/errors/parameter_missing/">parameter_missing</a>, <a href="/errors/version_unsupported/">version_unsupported</a> and resource-specific codes from the catalogue. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">401</span> <span>Codes: <a href="/errors/authentication_required/">authentication_required</a>, <a href="/errors/api_key_invalid/">api_key_invalid</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">403</span> <span>Codes: <a href="/errors/api_key_scope_missing/">api_key_scope_missing</a>, <a href="/errors/ip_not_allowed/">ip_not_allowed</a>, <a href="/errors/plan_limit_reached/">plan_limit_reached</a>. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">429</span> <span>Code: <a href="/errors/rate_limited/">rate_limited</a>. Retry-After is set. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--bad">503</span> <span>Code: <a href="/errors/service_unavailable/">service_unavailable</a>. Retry-After is set; writes are paused. <span class="api-field__type">Error</span></span></li>
<li class="api-response"><span class="api-status api-status--neutral">default</span> <span>Any other error, including <a href="/errors/internal_error/">internal_error</a>. Every code is in the error catalogue. <span class="api-field__type">Error</span></span></li>
</ul>

Errors share one shape; see the [error code catalogue](/errors/).

</div>
<div class="api-op__code">

**curl**

```sh wrap
curl -X GET \
  "https://api.ohauthcat.com/v1/branding" \
  -H "Authorization: Bearer $OHAUTHCAT_API_KEY"
```

**Node**

```javascript wrap
const response = await fetch("https://api.ohauthcat.com/v1/branding", {
  method: "GET",
  headers: {
    Authorization: `Bearer ${process.env.OHAUTHCAT_API_KEY}`,
  },
});
const data = await response.json();
```

**Python**

```python wrap
import os
import requests

response = requests.get(
    "https://api.ohauthcat.com/v1/branding",
    headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},
)
data = response.json()
```

```json title="Response 200" wrap
{
  "object": "branding",
  "app_name": "example_app_name",
  "light": {
    "primary": "#C94820",
    "background": "#C94820",
    "foreground": "#C94820",
    "accent": "#C94820"
  },
  "dark": {
    "primary": "#C94820",
    "background": "#C94820",
    "foreground": "#C94820",
    "accent": "#C94820"
  },
  "logo_url": "https://app.acme.com/callback",
  "font": "Inter",
  "radius": 1,
  "privacy_url": "https://app.acme.com/callback",
  "terms_url": "https://app.acme.com/callback",
  "favicon_url": "https://app.acme.com/callback",
  "font_url": "https://app.acme.com/callback",
  "surfaces": {
    "portal": {
      "light": {
        "primary": "#C94820",
        "background": "#C94820",
        "foreground": "#C94820",
        "accent": "#C94820"
      },
      "dark": {
        "primary": "#C94820",
        "background": "#C94820",
        "foreground": "#C94820",
        "accent": "#C94820"
      },
      "radius": 0,
      "logo_url": "https://app.acme.com/callback",
      "font": "Inter",
      "favicon_url": "https://app.acme.com/callback",
      "font_url": "https://app.acme.com/callback",
      "logo_url_dark": "https://example.com",
      "colors": {
        "page_background": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "card_background": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "text": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "muted_text": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "accent": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "border": {
          "light": "#C94820",
          "dark": "#C94820"
        }
      }
    },
    "consent": {
      "light": {
        "primary": "#C94820",
        "background": "#C94820",
        "foreground": "#C94820",
        "accent": "#C94820"
      },
      "dark": {
        "primary": "#C94820",
        "background": "#C94820",
        "foreground": "#C94820",
        "accent": "#C94820"
      },
      "radius": 0,
      "logo_url": "https://app.acme.com/callback",
      "font": "Inter",
      "favicon_url": "https://app.acme.com/callback",
      "font_url": "https://app.acme.com/callback",
      "logo_url_dark": "https://example.com",
      "colors": {
        "page_background": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "card_background": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "text": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "muted_text": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "accent": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "border": {
          "light": "#C94820",
          "dark": "#C94820"
        }
      }
    },
    "email": {
      "light": {
        "primary": "#C94820",
        "background": "#C94820",
        "foreground": "#C94820",
        "accent": "#C94820"
      },
      "dark": {
        "primary": "#C94820",
        "background": "#C94820",
        "foreground": "#C94820",
        "accent": "#C94820"
      },
      "radius": 0,
      "logo_url": "https://app.acme.com/callback",
      "font": "Inter",
      "favicon_url": "https://app.acme.com/callback",
      "font_url": "https://app.acme.com/callback",
      "logo_url_dark": "https://example.com",
      "colors": {
        "page_background": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "card_background": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "text": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "muted_text": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "accent": {
          "light": "#C94820",
          "dark": "#C94820"
        },
        "border": {
          "light": "#C94820",
          "dark": "#C94820"
        }
      }
    }
  }
}
```

</div>
</div>
