White Label - Get (partner get)

Returns the authenticated user's white-label configuration row (logos, favicon, domain prefix/name, sub-domain verification status), theme settings, and the email-templates-enabled flag for editing in the partner UI.

Auth: Both — authentication (route lives under the authenticated account/white-label group). The endpoint scopes target company by the body company_id when > 0, otherwise it falls back to the authenticated user's own company. No ownership check and no partner-tree walk — any company_id that Must be an existing account is accepted. Differs per role only in the fallback target (own company when company_id omitted/0).

Rate limit: No rate limit.

Request

  • Body:
FieldTypeRequiredNotes
company_idintegerNo`nullable

Response{ data. } envelope. (404 Company not found if neither resolves to an existing company.)

  • status (string) — success.
  • theme_settings (object|null) — latest RsUserThemeSetting row for the company (present only when a white-label row exists).
  • The account's name (string) — resolved company name, or ''.
  • data (object) — the spread RsWhiteLabel model with S3-resolved asset URLs overlaid; only email_templates_enabled is present when no white-label row exists:
  • all white-label record fields (e.g. id, company_id, domain_prefix, domain_name, white_url, title, status).
  • logo (string|null) — S3 URL with ?v=<timestamp> cache-buster, else null.
  • login_logo (string|null) — S3 URL, else null.
  • mobile_logo (string|null) — S3 URL, else null.
  • favicon (string|null) — S3 URL, else null.
  • subDomainSetting (string) — 'verified' when Amplify domain status AVAILABLE/active, 'Domain not found!', or '' (the status column is re-saved from this lookup).
  • email_templates_enabled (boolean).
  • instruction_file (string) — always ''.
  • partner_referral (string|null) — referral code when present, else null (only when a white-label row exists).
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
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