White Label - Get (partner get)

Overview

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

Prerequisites

• A bearer token. Callable with Partner and Account tokens.

Base URL

Endpoint

POST /api/v1/account/white-label/get

Authentication

• Requires a bearer token in the Authorization: Bearer <bearer-token> header.

• Who can call it: Partner and Account tokens.

• Authentication (route lives under the authenticated account/white-label group).

• The endpoint scopes the 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 for 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

• Body:

{
  "company_id": 5
}

Response

• data.status (string) — success.
• data.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.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).
• data.instruction_file (string) — always ''.
• data.partner_referral (null) — always null currently; reserved field.

200 OK (found) · 200

{
  "data": {
    "status": "success",
    "theme_settings": {
      "id": 1,
      "user_id": 3,
      "company_id": 5,
      "theme_options": "{\"mode\":\"system\",\"primaryColor\":\"#f1874c\"}",
      "created_at": "2026-06-11T11:53:05.000000Z",
      "updated_at": "2026-06-11T11:53:05.000000Z"
    },
    "company": {
      "name": "Yelp partner"
    },
    "data": {
      "id": 1,
      "company_id": 5,
      "domain_name": "manage-myreviews.com",
      "domain_prefix": "hipages",
      "white_url": "production.shoutaboutus.com",
      "title": "hipages",
      "status": "active",
      "logo": "https://d2ny6zb7otrnhl.cloudfront.net/white-label/logo/abc.png?v=1781608178",
      "login_logo": "https://d2ny6zb7otrnhl.cloudfront.net/white-label/login_logo/def.png",
      "mobile_logo": null,
      "favicon": "https://d2ny6zb7otrnhl.cloudfront.net/white-label/favicon/ghi.png",
      "subDomainSetting": "verified",
      "email_templates_enabled": true
    },
    "instruction_file": "",
    "partner_referral": null
  }
}

404 Not Found · 404

{
  "message": "Company not found",
  "status": "error",
  "errors": []
}

422 Unprocessable Entity · 422

{
  "message": "The selected company id is invalid.",
  "errors": {
    "company_id": [
      "The selected company id is invalid."
    ]
  }
}

Errors

Example request

curl --request POST \
  --url "https://production-api.shoutaboutus.com/api/v1/account/white-label/get" \
  --header 'Authorization: Bearer <bearer-token>' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{"company_id": 5}'