GET /v1/branding
- Scope
branding:read- Auth
- Secret key (
sk_…) - Since
- 1.0
Headers
Section titled “Headers”
Minor version; defaults to the environment’s pin.OhAuthCat-Versionstring
Responses
Section titled “Responses”- 200 OK Branding
- 400 Invalid request. Codes: parameter_invalid, parameter_missing, version_unsupported and resource-specific codes from the catalogue. Error
- 401 Codes: authentication_required, api_key_invalid. Error
- 403 Codes: api_key_scope_missing, ip_not_allowed, plan_limit_reached. Error
- 429 Code: rate_limited. Retry-After is set. Error
- 503 Code: service_unavailable. Retry-After is set; writes are paused. Error
- default Any other error, including internal_error. Every code is in the error catalogue. Error
Errors share one shape; see the error code catalogue.
curl -X GET \ "https://api.ohauthcat.com/v1/branding" \ -H "Authorization: Bearer $OHAUTHCAT_API_KEY"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();import osimport requests
response = requests.get( "https://api.ohauthcat.com/v1/branding", headers={"Authorization": f"Bearer {os.environ['OHAUTHCAT_API_KEY']}"},)data = response.json(){ "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" } } } }}