---
title: "List Widget Settings"
method: GET
path: "/api/v1/widget-settings/"
tags: ["WidgetSettingsService"]
---

# List Widget Settings

`GET /api/v1/widget-settings/`

## Request

- Base URL: `https://api.ravan.ai`
- URL: `https://api.ravan.ai/api/v1/widget-settings/`
- Auth: API key in header `X-Api-Key`

## Response `200`

Successful response

- ListWidgetSettingsResponse
  - `success` boolean
  - `message` string
  - `data` WidgetSettings[]
    - `id` string: Unique widget settings ID
    - `bot_name` string: Display name of the bot
    - `bot_auto_start` boolean: Whether the bot starts automatically
    - `bot_position` 'BOT_POSITION_UNSPECIFIED' | 'BOT_POSITION_BOTTOM_RIGHT' | 'BOT_POSITION_BOTTOM_LEFT' | 'BOT_POSITION_TOP_RIGHT' | 'BOT_POSITION_TOP_LEFT': Position of the bot widget on screen
    - `bot_logo` string: URL of the bot logo image
    - `svg_logo` string: SVG logo content
    - `custom_form_fields` object: Custom form field configuration
    - `theme` object: Widget theme configuration
    - `language` string: Language code (e.g. en, fr)
    - `consent_content` string: Consent modal body text
    - `consent_title` string: Consent modal title
    - `is_active` boolean: Whether these widget settings are active
    - `created_at` string: Creation timestamp
    - `updated_at` string: Last update timestamp

## Changes

- **2026-11-03** `53e6f393f46e`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/ravan/apis/agni-api/changes/api/v1/widget-settings/get.md)

---

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