---
title: "Read webchat installation and configuration"
method: GET
path: "/channels/{channelId}/webchat"
tags: ["Channels"]
---

# Read webchat installation and configuration

`GET /channels/{channelId}/webchat`

## Request

- Base URL: `https://platform-api.visitoai.com/m2m/v1`
- URL: `https://platform-api.visitoai.com/m2m/v1/channels/{channelId}/webchat`
- Auth: HTTP bearer

Use only for a discovered webchat channel. Returns the existing native public URL, installation snippet, widget configuration and setupState. The human installs the snippet on their website; no OAuth is needed. snippet_not_installed and firstSeenAt/lastSeenAt are installation evidence, not guest message delivery. Requires a current admin-owned credential to reuse the protected native setup reader. Requires `channels:read`.

## Path parameters

- `channelId` string, required

## Response `200`

Read webchat installation and configuration

- ChannelWebchatSetup
  - `channelId` string, required
  - `publicUrl` string
  - `tenantSlug` string
  - `setupState` string, required
  - `scriptUrl` string
  - `embedUrl` string
  - `installSnippet` string
  - `availability` object, required
    - `available` boolean, required
    - `tenantSlug` string
    - `reason` string
  - `settings` object, required
    - `themeColorHex` string
    - `launcherLabel` string
    - `headerTitle` string
    - `side` string
    - `sizePreset` string
    - `showLauncherLabel` boolean
    - `showPoweredByBranding` boolean
    - `bottomOffsetPx` integer
    - `prechat` object
      - `enabledFields` object
        - `name` boolean
        - `email` boolean
        - `phone` boolean
      - `requirementMode` string
      - `validationPolicy` string
    - `starterPrompts` object
      - `mode` string
    - `launcherAction` object
      - `mode` string
      - `targetChannelId` string
      - `whatsappPrefillText` string
  - `brandingRemoval` object, required
    - `canHide` boolean
    - `requiredTier` string
  - `launcherActionResolved` object, required
    - `type` string
    - `icon` string
    - `url` string
    - `fallbackReason` string
  - `firstSeenAt` string, date-time
  - `lastSeenAt` string, date-time

## Other responses

- `default`: Structured error

---

[API](https://skmtc.dev/visitoai/apis/visito-m2m-api.md) - [All operations](https://skmtc.dev/visitoai/apis/visito-m2m-api/llms.txt) - [OpenAPI document](https://skmtc.dev/visitoai/apis/visito-m2m-api/revisions/98377d35c234?raw)