Read active domain brand for hostname

GET

/domains/{domain}/brands/{hostname}/active

Last modified:2026-10-09 00:54:59

OperationId:GetActiveBrandForDomainByHostname

Returns the brand a domain shows on a hostname: the most specific active brand for that hostname, the domain, and its reseller. Requires Reseller, Super User, or Super User Read Only scope. A Reseller reaches only the domains in its own territory. The reseller is taken from the domain.

The lookup tries these combinations of hostname, reseller, and domain, and returns the first active brand it finds:

Order	hostname	reseller	domain
1	the hostname	the reseller	the domain
2	the hostname	the reseller	`*`
3	the hostname	`*`	the domain
4	the hostname	`*`	`*`
5	`*`	the reseller	the domain
6	`*`	the reseller	`*`
7	`*`	`*`	the domain
8	`*`	`*`	`*`

assets is merged from every brand in those combinations, active or not: for each asset type, the entry from the earliest combination wins. Each entry names the brand it came from in source-hostname, source-reseller, source-domain, and source-brand-name. matched-hostname is the hostname of the brand returned, which is * when a hostname-wide brand matched.

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Responses

🟢200OK

application/json

The active brand, with merged assets.

Bodyapplication/json

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://awqacore01.crexendocloud.com/ns-api/v2/domains//brands/portal.example.com/active' \
--header 'Authorization: Bearer <token>'

Response Example

200 - Active brand

{
    "id": "857f2c8ee324d783afc03b3921d826d5",
    "hostname": "portal.example.com",
    "reseller": "example-reseller",
    "domain": "example.com",
    "brand-name": "Sales Theme",
    "description": "Theme for the sales domain",
    "currently-active": 1,
    "color-primary": "#0F766E",
    "color-secondary": "#7C3AED",
    "color-success": "#059669",
    "color-info": "#0284C7",
    "color-error": "#DC2626",
    "color-warning": "#D97706",
    "font-family": "Inter, sans-serif",
    "font-family-url": null,
    "font-size-pixels": 16,
    "margin-pixels": 16,
    "padding-pixels": 16,
    "border-radius": 8,
    "icon-style": "baseline",
    "powered-by": "Powered by Example Company",
    "email-sender": "noreply@example.com",
    "created": "2026-09-03 11:00:00",
    "modified": "2026-09-03 11:00:00",
    "assets": [
        {
            "id": "259878452a8918f757a80438f613ef1d",
            "brand_id": "857f2c8ee324d783afc03b3921d826d5",
            "asset_type": "logo",
            "filename": "sales-logo.svg",
            "mime-type": "image/svg+xml",
            "width": 240,
            "height": 64,
            "file_size": 3920,
            "created": "2026-09-01 14:30:00",
            "modified": "2026-09-01 14:30:00",
            "download_url": "https://core1.example.com/ns-api/v2/domains/example.com/brands/portal.example.com/Sales+Theme/assets/logo/download",
            "source-hostname": "portal.example.com",
            "source-reseller": "example-reseller",
            "source-domain": "example.com",
            "source-brand-name": "Sales Theme"
        },
        {
            "id": "4feee1e3ebcbfb6a1abdcc20187496b4",
            "brand_id": "199c23e1f91546d031eb434db7627cc0",
            "asset_type": "favicon",
            "filename": "favicon.png",
            "mime-type": "image/png",
            "width": 32,
            "height": 32,
            "file_size": 1534,
            "created": "2026-09-01 14:30:00",
            "modified": "2026-09-01 14:30:00",
            "download_url": "https://core1.example.com/ns-api/v2/domains/example.com/brands/portal.example.com/Sales+Theme/assets/favicon/download",
            "source-hostname": "portal.example.com",
            "source-reseller": "example-reseller",
            "source-domain": "*",
            "source-brand-name": "Blue Theme"
        }
    ],
    "matched-hostname": "portal.example.com"
}

Modified at 2026-10-09 00:54:59

List domain brands for hostname

Read domain brand