---
title: "Get the web config"
method: GET
path: "/config"
tags: ["Internal"]
---

# Get the web config

`GET /config`

## Response `200`

The current web config

- WebConfig
  - `appearanceVariables` object
  - `name` string
  - `customStyles` string
  - `streamTitle` string
  - `offlineMessage` string
  - `logo` string
  - `version` string
  - `socketHostOverride` string
  - `extraPageContent` string
  - `summary` string
  - `tags` string[]
  - `socialHandles` SocialHandle[]
    - `platform` string
    - `url` string
    - `icon` string
  - `externalActions` ExternalAction[]
    - `url` string
    - `html` string
    - `title` string
    - `description` string
    - `icon` string
    - `color` string
    - `openExternally` boolean
  - `notifications` NotificationConfig
    - `browser` BrowserConfig
      - `publicKey` string
      - `enabled` boolean
  - `federation` FederationConfig
    - `account` string
    - `followerCount` integer
    - `enabled` boolean
    - `hideFollowersTab` boolean
  - `maxSocketPayloadSize` integer
  - `hideViewerCount` boolean
  - `chatDisabled` boolean
  - `chatRequireAuthentication` boolean — Whether users must authenticate before sending chat messages
  - `nsfw` boolean
  - `autoplay` 'off' | 'always' | 'sound-only' — Viewer autoplay behavior.
  - `authentication` AuthenticationConfig
    - `indieAuthEnabled` boolean

## Other responses

- `500` — Internal Server Error

## Changes

- **2026-07-02** `098518381009` — 1 info
  - added the optional property `autoplay` to the response with the `200` status
- **2026-06-20** `ba236acfe73a` — 1 info
  - added the optional property `federation/hideFollowersTab` to the response with the `200` status
- **2026-01-28** `ced4cb76d3fb` — 1 info
  - added the optional property `chatRequireAuthentication` to the response with the `200` status
- **2024-07-02** `618b7ae59cc5` — 1 info
  - endpoint added
- **2021-09-23** `02fef72d775b` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/owncast/apis/owncast-apis/changes/config/get.md)

---

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