---
title: "Get Workspace Echo Config"
method: GET
path: "/api/workspaces/{workspace_id}/echo-config"
---

# Get Workspace Echo Config

`GET /api/workspaces/{workspace_id}/echo-config`

## Path parameters

- `workspace_id` string, required

## Query parameters

- `includeOrg` boolean

## Headers

- `Authorization` string, nullable

## Response `200`

Successful Response

- union
  - EchoConfigResponse
    - `id` string, required
    - `workspaceId` string, required
    - `position` string, required
    - `theme` string, required
    - `agentName` string, required
    - `welcomeMessage` string, required
    - `logoUrl` string, nullable
    - `primaryColor` string, required
    - `userBubbleColor` string, required
    - `userBubbleTextColor` string, required
    - `botBubbleColor` string, required
    - `botBubbleTextColor` string, required
    - `headerGradientFrom` string, required
    - `headerGradientTo` string, required
    - `launcherSize` string, required
    - `borderRadius` string, required
    - `shadowSize` string, required
    - `inputPlaceholder` string, required
    - `suggestions` string[]
    - `hideSuggestionsOnInteract` boolean
    - `previewMessages` string[]
    - `autoShowPreviewDelay` integer
    - `showBranding` boolean
    - `privacyPolicyUrl` string, required
    - `enableLeadCapture` boolean
    - `leadCaptureKeywords` string[]
    - `leadCaptureMinutesThreshold` integer
    - `leadCaptureMessageThreshold` integer
    - `targetAgentIdForLeads` string, nullable
    - `enableBrochure` boolean
    - `brochureSuggestionText` string, required
    - `allowedDomains` string[]
    - `enableVoiceCall` boolean
    - `selectedUseCaseId` string, nullable
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - EchoConfigWithWorkspaceResponse
    - `id` string, required
    - `name` string, required
    - `information` string, nullable
    - `type` string, nullable
    - `callProvider` string, nullable
    - `enableVoiceCall` boolean

## Other responses

- `422` — Validation Error

## Changes

> 16 revisions in range; 13 could not be searched.

- **2026-07-31** `7c9aff2501f3` — 1 warning, 1 info
  - removed the optional property `anyOf[subschema #1: EchoConfigResponse]/selectedCampaignId` from the response with the `200` status
  - added the optional property `anyOf[subschema #1: EchoConfigResponse]/selectedUseCaseId` to the response with the `200` status

[Change history](https://skmtc.dev/outcallerai/apis/fastapi/changes/api/workspaces/:workspace_id/echo-config/get.md)

---

[API](https://skmtc.dev/outcallerai/apis/fastapi.md) · [All operations](https://skmtc.dev/outcallerai/apis/fastapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/outcallerai/fastapi/revisions/6155db644bab/schema)