---
title: "Get Widget Config"
method: GET
path: "/public/widget/config/{widget_key}"
tags: ["public", "widget-public"]
---

# Get Widget Config

`GET /public/widget/config/{widget_key}`

## Request

- Base URL: `https://api-docs.upsmith.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api-docs.upsmith.com/public/widget/config/{widget_key}`
- Auth: none declared

## Path parameters

- `widget_key` string, required

## Headers

- `timezone` string
- `x-user-id` string, nullable
- `x-actor-email` string, nullable
- `x-request-source` string, nullable
- `x-operation-id` string, nullable
- `x-commit-message` string, nullable
- `x-confirmation-id` string, nullable
- `x-chat-id` string, nullable

## Response `200`

Successful Response

- WidgetConfigPublic
  - `enabled` boolean, required
  - `demo` boolean
  - `brandName` string, required
  - `brandLogoUrl` string, nullable
  - `theme` WidgetThemePublic, required
    - `primaryColor` string, required
    - `launcherLabel` string, required
    - `launcherPosition` string, required
  - `copy` WidgetCopyPublic, required
    - `modalTitle` string, required
    - `subhead` string, required
    - `ctaLabel` string, required
    - `optInText` string, required
    - `optInCopyOverride` string, nullable
    - `consentText` string, required
    - `bookingConsentText` string, nullable
    - `marketingConsentText` string, nullable
  - `termsUrl` string, nullable
  - `privacyUrl` string, nullable
  - `intents` WidgetIntentChipPublic[], required
    - `key` string, required
    - `label` string, required
  - `intentMode` 'chips' | 'text' | 'hidden'
  - `intentPrompt` string
  - `intentTextPlaceholder` string
  - `intentTextMaxLength` integer
  - `responseStatusText` string, nullable
  - `originAllowlist` string[], required
  - `trust` WidgetTrustPublic
    - `rating` number, required
    - `reviewCount` integer, required
    - `neighborCount` integer, nullable
  - `zipRoutingEnabled` boolean
  - `outOfAreaMessage` string, nullable
  - `turnstileSiteKey` string, nullable

## Other responses

- `422`: Validation Error

---

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