Skip to main content
GET
Get workspace white label

Authorizations

Authorization
string
header
required

Personal access token, sent as Authorization: Bearer <token>. Each operation lists the permission it needs: read_only or full_access. A full-access token can call every operation. A read-only token can call only the operations that list read_only; anything else returns 403 read_only_credential_route_not_allowed.

Path Parameters

workspace_id
string
required

ID of the workspace. With a personal access token or a workspace API key, use its workspace. Get it from organization_id in Get app.

Response

The workspace's white-label settings.

enabled
boolean
required

Whether the builder runs under the workspace's brand instead of Base44's.

Example:

true

brand_name
string | null
required

Name of the workspace's platform. null until one is saved.

Example:

"Northlight Studio"

agent_name
string | null
required

What the agent calls itself. null means it answers to brand_name.

Example:

"Scout"

agent_prompt
string | null
required

The system prompt every app in the workspace is built under, as stored after sanitizing. null means the workspace's apps use Base44's built-in prompt.

Example:

"You are Scout, the app builder for Northlight Studio. Build every app with our component library."

use_default_design_system
boolean
required

Whether the workspace's default design system is added to the agent prompt.

Example:

true

controls_visible
boolean
required

Whether white label is available to this workspace: it's enrolled in Base44 for platforms, or white label is already on. When it's false, enabled can't be set to true.

Example:

true

can_edit_brand
boolean
required

Whether the plan allows brand_name, agent_name and use_default_design_system (Builder and up).

Example:

true

can_edit_prompt
boolean
required

Whether the plan allows agent_prompt (custom Enterprise).

Example:

true