---
title: "List Widget integrations"
method: GET
path: "/integration/widget/list"
tags: ["Widget Integration"]
---

# List Widget integrations

`GET /integration/widget/list`

## Request

- Base URL: `https://api.chatbotkit.com/api/v1`
- URL: `https://api.chatbotkit.com/api/v1/integration/widget/list`
- Auth: HTTP bearer

## Query parameters

- `cursor` string: The cursor to use for pagination
- `order` 'asc' | 'desc': The order of the paginated items
- `take` integer: The number of items to retrieve
- `meta` object: Key-value pairs to filter the items by metadata

## Response `200`

The list of Widget integrations was retrieved successfully

- object
  - `items` object[], required
    - `alias` string, nullable: The unique alias for the instance
    - `name` string: The associated name
    - `description` string: The associated description
    - `meta` Meta: Meta data information
    - `id` string, required: The instance ID
    - `createdAt` number, required: The timestamp (ms) when the instance was created
    - `updatedAt` number, required: The timestamp (ms) when the instance was updated
    - `blueprintId` string, nullable: The ID of the blueprint
    - `botId` string, nullable: The ID of the bot this configuration is using
    - `theme` string: The theme of the Widget integration
    - `layout` string: The default layout of the Widget integration
    - `title` string: The title of the Widget integration
    - `intro` string: The intro of the Widget integration
    - `initial` string: The initial message of the Widget integration
    - `placeholder` string: The input placeholder of the Widget integration
    - `origin` string: The origin URLs of the Widget integration
    - `sessionDuration` number: The session duration of the Widget integration
    - `language` string: The language of the Widget integration
    - `plugins` string: The plugins of the Widget integration
    - `stream` boolean: Whether the Widget integration is streaming
    - `verbose` boolean: Whether the Widget integration is verbose
    - `tools` boolean: Whether the Widget integration has tools
    - `unfurl` boolean: Whether the Widget integration unfurls links
    - `math` boolean: Weather the Widget integration supports math
    - `carousel` boolean: Weather the Widget integration supports carousels
    - `form` boolean: Weather the Widget integration supports forms
    - `attachments` boolean: Weather the Widget integration supports attachments
    - `autoScroll` boolean: Whether the Widget integration auto scrolls
    - `startFirst` boolean: Whether the Widget integration starts first
    - `contactCollection` boolean: Whether the Widget integration collects contacts
    - `exportConversation` boolean: Controls whether the Widget allows exporting the current conversation
    - `restartConversation` boolean: Controls whether the Widget allows restarting the conversation
    - `maximize` boolean: Controls whether the Widget allows maximizing the conversation
    - `messagePeek` boolean: Controls whether the Widget allows peeking at the initial messages
    - `voiceIn` boolean: Whether the Widget integration supports voice input
    - `voiceOut` boolean: Whether the Widget integration supports voice output
    - `poweredBy` boolean: Whether the Widget integration displays powered by
  - `cursor` string, required: Cursor for fetching the next page

## Other responses

- `default`: An error response

---

[API](https://skmtc.dev/chatbotkit/apis/cbk-api.md) · [All operations](https://skmtc.dev/chatbotkit/apis/cbk-api/llms.txt) · [OpenAPI document](https://skmtc.dev/chatbotkit/apis/cbk-api/revisions/13d250576136?raw)