White Label - Resolve branding (public/login)

Resolve white-label branding (logo, login logo, favicon, title, white-label URL, status) and saved theme options for a company so the SPA can account the login screen before authentication.

Auth: Both — public route under (no authentication, authorize returns true). The endpoint scopes target company either by an explicit company_id in the body, or — when you omit it — by matching the request Referer host (extractDomainParts → subdomain + domain) against an rs_white_labels row (domain_prefix + domain_name). No partner-tree walk or an ownership check. If no company resolves, still HTTP 200 with status: error.

Rate limit: 30 requests/min.

Request

  • Body:
FieldTypeRequiredNotes
company_idintegerNoMust be an existing account inside the caller's own tree; sending it requires a bearer token (403 otherwise). When omitted, the company resolves from domain or the Referer host.
domainstringNoMax 255. A white-label host (URL or bare host) to resolve by; preferred over the Referer header.

Response{ data. } envelope.

  • status (string) — success when a company resolved, else error.
  • data.data.white_label (object) — the branding block. Falls back to defaults if the company has no white-label record (walks to parent company if the company has a parent with bundle_id > 0):
  • logo (string) — S3 URL or ''.
  • white_url (string) — https://-prefixed white-label URL when status active, else config('common.APP_FRONTEND_URL').
  • favicon (string) — S3 URL or ''.
  • title (string) — white-label title or config('app.name').
  • status (string) — active / inactive.
  • login_logo (string) — S3 URL; falls back to logo when empty.
  • company_id (integer|null) — resolved white-label company id, else null.
  • email_templates_enabled (boolean) — flag.
  • data.data.theme_options (string|null) — theme_options JSON string, or null.
  • On failure: status: error, data: [], message: "Company not found".

Errors: 403 when company_id is sent without a bearer token or the account sits outside the caller's own tree.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
string
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json