Get Agency Branding

Read the stored branding settings.

GEThttps://api.foxreach.io/api/v1/agency/branding

Requires an API key with the read scope.

Only API keys of an Agency workspace can call this endpoint (403 agency_required otherwise). The call always runs in the key's own workspace; X-Workspace-Id is ignored.

These settings are stored with your agency. FoxReach does not apply them to what client workspace members see yet (Planned).

Response#

dataobject

Show data

brandNamestring

Brand name shown to clients, or null.

logoUrlstring

HTTPS logo URL, or null.

faviconUrlstring

HTTPS favicon URL, or null.

primaryColorstring

Hex color.

accentColorstring

Hex color.

hideWatermarkboolean

Whether the FoxReach watermark is hidden.

hasOpenaiKeyboolean

Whether a bring-your-own OpenAI key is stored. The key itself is never returned.

Errors#

Status	Description
`401`	Missing, invalid, revoked or expired API key
`403`	API key does not have the required scope: `read`
`403`	`agency_required`: the key's workspace does not hold an Agency plan

Rate Limit#

300 requests per minute, shared by every read call in your workspace. Fixed 60-second window.
Every response includes X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset (unix epoch seconds) and X-RateLimit-Bucket (read).
A 429 response includes a Retry-After header (seconds until the bucket resets).

For client-side patterns, see Rate Limiting.

Request

cURL

curl "https://api.foxreach.io/api/v1/agency/branding" \
  -H "X-API-Key: otr_your_key"

Python SDK

from foxreach import FoxReach

client = FoxReach(api_key="otr_your_key")
branding = client.agency.get_branding()

TypeScript SDK

import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const branding = await client.agency.getBranding();

Response

JSON

{
  "data": {
    "brandName": "Acme Outreach",
    "logoUrl": "https://acme.com/logo.svg",
    "faviconUrl": null,
    "primaryColor": "#E07A5F",
    "accentColor": "#4A7C59",
    "hideWatermark": true,
    "hasOpenaiKey": false
  }
}

Was this page helpful?

View as MarkdownLast updated November 4, 2026