Get an org branding
Settings module
GET/org-branding/{id}orgBrandings.get
White label brand settings for Atlas, Gateway, email and Compass. Returns one org branding with its `ETag`. A org branding the caller may not see returns 404.
- Requires the capability org.settings.read.
- OAuth scopes: org.
- Error statuses: 400, 401, 404, 429. Errors are RFC 9457 problem details.
Path and query parameters
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the org branding. |
| fields | Fields | No | Sparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Constraints: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$ |
Response 200: OrgBranding
| Field | Type | Required | Description |
|---|---|---|---|
| id | string (uuid) | Yes | Identifier of the org branding. |
| org_id | string (uuid) | Yes | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Yes | When the row was created. |
| created_by | string (uuid) | null | Yes | Identifier of the person who created the row; null when a seed, platform or system process created it. |
| updated_at | string (date-time) | Yes | When the row was last updated. |
| updated_by | string (uuid) | null | Yes | Identifier of the person who last updated the row; null when a seed, platform or system process updated it. |
| display_name | string | null | Yes | Brand display name.Constraints: length 1 to 300 |
| logo_light_path | string | null | Yes | Logo for light themes: object path in the org-brand bucket, starting with the org id.Constraints: length 1 to 1024 |
| logo_dark_path | string | null | Yes | Logo for dark themes: object path in the org-brand bucket.Constraints: length 1 to 1024 |
| favicon_path | string | null | Yes | Favicon: object path in the org-brand bucket.Constraints: length 1 to 1024 |
| app_icon_path | string | null | Yes | App icon: object path in the org-brand bucket.Constraints: length 1 to 1024 |
| accent_hex | string | null | Yes | Accent color as uppercase #RRGGBB, replacing accent-default in every theme; null keeps the platform accent.Constraints: pattern ^#[0-9A-F]{6}$ |
| neutral_tint_hex | string | null | Yes | Optional neutral tint as uppercase #RRGGBB.Constraints: pattern ^#[0-9A-F]{6}$ |
| font_family | string | null | Yes | Font family from the approved list; null keeps the platform font.Constraints: length 1 to 300 |
| radius_scale | "Compact" | "Default" | "Rounded" | Yes | Corner radius scale. |
| email_sender_name | string | null | Yes | Sender name on emails sent for the org.Constraints: length 1 to 300 |
| support_email | string (email) | null | Yes | Support address shown on branded surfaces. |
| legal_entity_name | string | null | Yes | Legal entity named on generated documents and emails.Constraints: length 1 to 300 |
| suppress_powered_by | boolean | Yes | True hides Powered by XOS; it takes effect only while the plan includes white label. |
{
"id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"created_at": "2026-10-08T14:30:00Z",
"created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"updated_at": "2026-10-08T14:30:00Z",
"updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"display_name": "Northwind Live",
"logo_light_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/logo-light.svg",
"logo_dark_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/logo-light.svg",
"favicon_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/logo-light.svg",
"app_icon_path": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/logo-light.svg",
"accent_hex": "#1F6FEB",
"neutral_tint_hex": "#1F6FEB",
"font_family": "Inter",
"radius_scale": "Compact",
"email_sender_name": "Northwind Live",
"support_email": "alex.rivera@northwindlive.example",
"legal_entity_name": "Northwind Live LLC",
"suppress_powered_by": false
}Code samples
curl -X GET "$XOS_BASE_URL/org-branding/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f" \
-H "Authorization: Bearer $XOS_API_KEY"const { data, etag } = await xos.orgBrandings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.org_brandings.get("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos org-brandings get 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f