# Get Agency Branding

> Read the stored branding settings.

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

<ResponseField name="data" type="object">
  <Expandable title="data">
    <ResponseField name="brandName" type="string">Brand name shown to clients, or `null`.</ResponseField>
    <ResponseField name="logoUrl" type="string">HTTPS logo URL, or `null`.</ResponseField>
    <ResponseField name="faviconUrl" type="string">HTTPS favicon URL, or `null`.</ResponseField>
    <ResponseField name="primaryColor" type="string">Hex color.</ResponseField>
    <ResponseField name="accentColor" type="string">Hex color.</ResponseField>
    <ResponseField name="hideWatermark" type="boolean">Whether the FoxReach watermark is hidden.</ResponseField>
    <ResponseField name="hasOpenaiKey" type="boolean">Whether a bring-your-own OpenAI key is stored. The key itself is never returned.</ResponseField>
  </Expandable>
</ResponseField>

<RequestExample>
```bash cURL
curl "https://api.foxreach.io/api/v1/agency/branding" \
  -H "X-API-Key: otr_your_key"
```

```python Python SDK
from foxreach import FoxReach

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

```typescript TypeScript SDK
import { FoxReach } from "foxreach";

const client = new FoxReach({ apiKey: "otr_your_key" });
const branding = await client.agency.getBranding();
```
</RequestExample>

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

## 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](/rate-limiting).