Get branding

Overview

See the current branding for an account or partner.

Use this to load settings for editing.

You'll need a partner or account token.

Returns domain, logos, colours, and email sender settings.

When the account has no white-label setup yet, you still get 200, with a smaller response: theme_settings and partner_referral are absent (not null), and data carries only email_templates_enabled. Check for data.data.id before reading any branding field.

Prerequisites

A bearer token. See Authentication.
Optional: the account's id (company_id). Leave it out to get the branding of your own account.

Base URL

Environment	URL
Production	`https://production-api.shoutaboutus.com`
Development	`https://development-api.shoutaboutus.com`

Endpoint

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

Authentication

Partner or Account token

company_id must be inside your own account tree. A Partner token can read any account under the partner; an Account token only its own account.
Without company_id, you get the account of the user behind the token.
An account outside your tree, or one that doesn't exist, is rejected with 422.

Rate limit

This endpoint has no rate limit.

Request parameters

None.

Request body

Field	Type	Required	Description
`company_id`	integer	No	The account. Must exist and be inside your account tree. Leave it out to use the account of the user behind the token.

Request payload

{
  "company_id": 5994
}

Response body

The payload is inside data.

Field	Type	Description
`status`	string	`success`.
`theme_settings`	object or null	The account's saved theme (colours), or `null` when none is saved. Absent when white label isn't set up.
`theme_settings.id`	integer	The theme setting's id.
`theme_settings.user_id`	integer or null	The user who last saved the theme.
`theme_settings.company_id`	integer	The account.
`theme_settings.theme_options`	string	The theme settings, as saved (a JSON-encoded string).
`theme_settings.deleted_at`	string or null	`null`.
`theme_settings.created_at`	string	When the theme was first saved (ISO 8601).
`theme_settings.updated_at`	string	When the theme was last saved (ISO 8601).
`company`	object	The account.
`company.name`	string	The account's name.
`data`	object	The white-label settings. Only `email_templates_enabled` when white label isn't set up.
`data.id`	integer	The white-label record's id. Present only when white label is set up.
`data.company_id`	integer	The account.
`data.domain_name`	string	The custom domain, e.g. `manage-myreviews.com`.
`data.domain_prefix`	string or null	The subdomain, e.g. `acme`.
`data.white_url`	string or null	The full branded host, `domain_prefix.domain_name`.
`data.email`	string or null	Email address saved on the white-label record, if any.
`data.logo`	string or null	URL of the main logo (with a `?v=` cache-buster), or `null`.
`data.login_logo`	string or null	URL of the login-page logo, or `null`.
`data.mobile_logo`	string or null	URL of the mobile logo, or `null`.
`data.favicon`	string or null	URL of the favicon, or `null`.
`data.title`	string or null	The browser title.
`data.status`	string or null	`active` once the domain is live, otherwise `inactive`. Refreshed on every call.
`data.created_at`	string	When white label was set up (ISO 8601).
`data.updated_at`	string	When it was last changed (ISO 8601).
`data.deleted_at`	string or null	`null`.
`data.subDomainSetting`	string or object	The custom domain's state: `verified` when it's live, `Domain not found!` when our hosting doesn't know it, `''` when no domain is set, or the hosting provider's setup details (an object) while it's still being set up.
`data.email_templates_enabled`	boolean	Whether the email templates section is turned on for the account's partner. When `false`, the email template endpoints return `403`. Present in both shapes.
`instruction_file`	string	Always an empty string here.
`partner_referral`	string or null	The account's latest referral code, or `null`. Absent when white label isn't set up.

Response payload

{
  "data": {
    "status": "success",
    "theme_settings": {
      "id": 1,
      "user_id": 3011,
      "company_id": 5994,
      "theme_options": "{\"mode\":\"system\",\"primaryColor\":\"#f1874c\"}",
      "deleted_at": null,
      "created_at": "2026-06-11T11:53:05.000000Z",
      "updated_at": "2026-06-11T11:53:05.000000Z"
    },
    "company": {
      "name": "Acme Coffee"
    },
    "data": {
      "id": 1,
      "company_id": 5994,
      "domain_name": "manage-myreviews.com",
      "domain_prefix": "acme",
      "white_url": "acme.manage-myreviews.com",
      "email": null,
      "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",
      "title": "Acme Reviews",
      "status": "active",
      "created_at": "2026-06-11T11:53:05.000000Z",
      "updated_at": "2026-06-11T11:53:05.000000Z",
      "deleted_at": null,
      "subDomainSetting": "verified",
      "email_templates_enabled": true
    },
    "instruction_file": "",
    "partner_referral": null
  }
}

Examples

Success payload

White label set up: see Response payload.

White label isn't set up yet:

{
  "data": {
    "status": "success",
    "company": {
      "name": "Acme Coffee"
    },
    "data": {
      "email_templates_enabled": true
    },
    "instruction_file": ""
  }
}

Error payload

404 Account not found

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

422 Account outside your tree

{
  "message": "The selected company id does not belong to your company hierarchy.",
  "errors": {
    "company_id": [
      "The selected company id does not belong to your company hierarchy."
    ]
  }
}

422 Account doesn't exist

{
  "message": "The selected company id is invalid. (and 1 more error)",
  "errors": {
    "company_id": [
      "The selected company id is invalid.",
      "The selected company id does not belong to your company hierarchy."
    ]
  }
}

Status	Meaning
`200`	The branding, or the smaller response when white label isn't set up.
`401`	The token is missing, expired or invalid.
`404`	The account wasn't found.
`422`	`company_id` doesn't exist or is outside your tree.
`500`	Unexpected server error.

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": 5994}'