Account

Get your brand kit

GEThttps://api.ruuster.com/v1/brand

Your brokerage's name, logo, phone, website and the colors and fonts your Ruuster site is styled with, so reports and documents built from the API can carry your brand.

Authentication: x-api-key and x-email headers of an owner or admin
Rate limit: 120 requests per minute per key

View as Markdown

The brand kit is what your Ruuster-powered site already uses: the name and full logo from your brokerage profile, your app icon and favicon when your site has them, and the colors and fonts from your site's UI customization. Nothing here is guessed; when a value isn't set on your site it comes back null, and source says which customization it came from. Change it where you change your site's look in Ruuster, and the next call reflects it.

Through the MCP server this is the brand tool. Assistants are told to use it in anything seller-facing, so a seller report, CMA write-up or listing presentation carries your logo, name and colors. seller_report, cma_create and cma_get include it, and the visual CMA is drawn with your logo, colors and fonts.

Response

Field	Description
`brokerage`	`name` (your site's title, else the brokerage name), `tagline`, `phone` (the client-facing number)
`logo`	`url`: your full logo from your brokerage profile, the one your site shows (`null` when none is set or it's turned off), with `source` `brokerage`; `appIcon` (your branded app's square icon, for places a square mark fits), `favicon`, `socialImage` (the image your site shares on social platforms)
`website`	`primaryUrl`, `hostnames`, `appStoreUrl`, `googlePlayUrl` when you have branded apps
`colors`	Hex values: `primary`, `secondary`, `accent`, `background`, `text`, `textSecondary`, `link`, `button`, `buttonText`, and `onPrimary` (black or white, whichever reads on `primary`)
`fonts`	`heading`, `body` (family names)
`source`	`uiCustomizationV2`, `uiCustomization` or `none`
`subdomain`	The site the colors were read from

Not a lookup call; one quick read per request. Logo files are hosted by Ruuster and can be embedded or downloaded for use in your own documents under your agreement with Ruuster.

Request

curl -s "https://api.ruuster.com/v1/brand" \
  -H "x-api-key: $RUUSTER_API_KEY" \
  -H "x-email: $RUUSTER_EMAIL"

const res = await fetch("https://api.ruuster.com/v1/brand", {
  headers: {
    "x-api-key": process.env.RUUSTER_API_KEY,
    "x-email": process.env.RUUSTER_EMAIL,
  },
});
const body = await res.json();
if (!body.ok) throw new Error(`${body.error.code}: ${body.error.message} (${body.requestId})`);
console.log(body.data);

import os
import requests

res = requests.get(
    "https://api.ruuster.com/v1/brand",
    headers={"x-api-key": os.environ["RUUSTER_API_KEY"], "x-email": os.environ["RUUSTER_EMAIL"]},
    timeout=30,
)
body = res.json()
if not body["ok"]:
    raise RuntimeError(f'{body["error"]["code"]}: {body["error"]["message"]} ({body.get("requestId")})')
print(body["data"])

{ "ok": true, "data": { "brokerage": { "name": "Saguaro Realty Group", "tagline": "Tucson's neighborhood experts", "phone": "+15205550101" }, "logo": { "url": "https://cdn.example.com/agents/saguaro/logo", "source": "brokerage", "appIcon": "https://cdn.example.com/white-labeling/saguaro/logo.png", "favicon": "https://cdn.example.com/white-labeling/saguaro/favicon.ico", "socialImage": "https://cdn.example.com/white-labeling/saguaro/logo.png" }, "website": { "primaryUrl": "https://saguaro.ruuster.com", "hostnames": ["saguaro.ruuster.com"], "appStoreUrl": null, "googlePlayUrl": null }, "colors": { "primary": "#0a5cb8", "secondary": "#aae6ff", "accent": "#ffd24d", "background": "#e8f3fc", "text": "#13203c", "textSecondary": "#5378c8", "link": "#00bbff", "button": "#ffd24d", "buttonText": "#13203c", "onPrimary": "#ffffff" }, "fonts": { "heading": "Poppins", "body": "Roboto" }, "source": "uiCustomization", "subdomain": "saguaro" }, "meta": { "brokerageId": "4f6c2a9e-8d31-4b57-9a0e-2c7d5e1b8f43" } }