---
title: "Get Settings"
method: GET
path: "/api/workspaces/{slug}/settings"
tags: ["Workspaces"]
---

# Get Settings

`GET /api/workspaces/{slug}/settings`

## Request

- Base URL: `https://api.kolens.ai` (the document declares no server; this is the origin it was published from)
- URL: `https://api.kolens.ai/api/workspaces/{slug}/settings`
- Auth: HTTP bearer

## Path parameters

- `slug` string, required

## Headers

- `x-kolens-user-id` string, nullable

## Response `200`

Successful Response

- WorkspaceSettingsOut: Admin-visible settings on a workspace. Phase 2 ships ``brand_voice_text`` (the AI compose doc) and the daily-credits counter so the settings UI can show usage / cap. Phase 3 (EPIC #198) adds the four structured brand-profile fields used by the KOL brand-fit scoring path.
  - `id` string, required
  - `slug` string, required
  - `brand_voice_text` string, nullable
  - `product_category` string, nullable
  - `target_audience_text` string, nullable
  - `target_geographies` string[], nullable
  - `exclusions_text` string, nullable
  - `sender_name` string, nullable
  - `sender_title` string, nullable
  - `sender_brand_name` string, nullable
  - `email_signature` string, nullable
  - `ai_credits_used_today` integer
  - `ai_credits_day` string, nullable
  - `ai_daily_token_cap` integer

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/kolens/apis/kolens-api.md) · [All operations](https://skmtc.dev/kolens/apis/kolens-api/llms.txt) · [OpenAPI document](https://skmtc.dev/kolens/apis/kolens-api/revisions/5d6865ab0a24?raw)