---
title: "Get details of a chat widget."
method: GET
path: "/v1/chatwidgets/{id}"
tags: ["ChatWidget"]
---

# Get details of a chat widget.

`GET /v1/chatwidgets/{id}`

## Path parameters

- `id` integer, required

## Response `200`

OK

- ChatWidgetModel
  - `id` integer
  - `accountId` integer
  - `departmentId` integer
  - `name` string, required
  - `domain` string, required
  - `workingHourType` integer
  - `offlineMsg` string, nullable
  - `onlineMsg` string, nullable
  - `chatTitle` string, nullable
  - `chatSubtitle` string, nullable
  - `chatTitleOffline` string, nullable
  - `chatSubtitleOffline` string, nullable
  - `botLogo` string, nullable
  - `language` string, nullable
  - `status` boolean
  - `contactInfo` string, nullable
  - `messages` string, nullable
  - `showEmojiButton` boolean
  - `allowVisitorCloseChat` boolean
  - `showAttachmentButton` boolean
  - `showChatHistory` boolean
  - `otpEnabled` boolean
  - `otpEmailRawHtml` boolean
  - `mailId` integer
  - `removeBranding` boolean
  - `apiKey` string, nullable
  - `identityVerification` boolean
  - `privateKey` string, nullable
  - `primaryColor` string, nullable
  - `contactInfoEnabled` boolean
  - `androidKey` string, nullable
  - `iosKey` string, nullable
  - `integrations` string, nullable
  - `chatHomePage` ChatHomePage
    - `id` integer
    - `enabled` boolean
    - `logo` string, nullable
    - `title` string, nullable
    - `subtitle` string, nullable
    - `chatStarterTitle` string, nullable
    - `chatStarterSubtitle` string, nullable
    - `desk` string, nullable
    - `widgets` ChatHomepageWidget[], nullable
      - `component` string, nullable
      - `props` string, nullable
  - `desk` ChatDesk
    - `_id` string, nullable
    - `domain` string, nullable
    - `slug` string, nullable
  - `survey` Survey
    - `id` integer
    - `accountId` integer
    - `departmentId` integer
    - `name` string, nullable
    - `message` string, nullable
    - `linkedId` integer
    - `linkedTable` 0 | 1 | 2 | 5 | 6 | 7 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 19 | 20 | 21 | 22 | 23 | 25 | 26 | 27 | 31 | 32 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 50 | 51 | 52 | 53 | 55 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 72 — Infoset data objects<p>Enum values:</p><ul><li><i>0 = None</i></li><li><i>1 = Company</i></li><li><i>2 = Contacts</i></li><li><i>5 = Deals</i></li><li><i>6 = EmailLogs</i></li><li><i>7 = Emails</i></li><li><i>10 = MailAccounts</i></li><li><i>11 = MarketingLog</i></li><li><i>12 = MarketingSession</i></li><li><i>13 = MarketingTable</i></li><li><i>14 = Pipeline</i></li><li><i>15 = PipelineStages</i></li><li><i>16 = Todos</i></li><li><i>19 = TicketLogs</i></li><li><i>20 = Tickets</i></li><li><i>21 = Users</i></li><li><i>22 = Settings</i></li><li><i>23 = ContactGroups</i></li><li><i>25 = UserRights</i></li><li><i>26 = CustomUserRights</i></li><li><i>27 = UserGroups</i></li><li><i>31 = Automations</i></li><li><i>32 = Subjects</i></li><li><i>34 = Categories</i></li><li><i>35 = CallLogs</i></li><li><i>36 = Voicemails</i></li><li><i>37 = UserChannelRights</i></li><li><i>38 = CallCenterQueues</i></li><li><i>39 = DialPlans</i></li><li><i>40 = ServiceProviders</i></li><li><i>41 = IvrMenus</i></li><li><i>42 = IvrMenuDetails</i></li><li><i>43 = IvrPlugins</i></li><li><i>44 = VoipUsers</i></li><li><i>45 = DialerTable</i></li><li><i>46 = DialerSession</i></li><li><i>47 = DialerSessionLog</i></li><li><i>48 = DialerDtmfLink</i></li><li><i>50 = ChatRooms</i></li><li><i>51 = ChatTable</i></li><li><i>52 = ChatMessages</i></li><li><i>53 = ChatWidgets</i></li><li><i>55 = OutboundMessages</i></li><li><i>60 = ChatWidgetHomepage</i></li><li><i>61 = Chatbot</i></li><li><i>62 = ChatbotObject</i></li><li><i>63 = DealLogs</i></li><li><i>64 = SlaPolicies</i></li><li><i>65 = Sms</i></li><li><i>66 = Survey</i></li><li><i>67 = Announcements</i></li><li><i>68 = AnnouncementReadLogs</i></li><li><i>69 = AuditLogs</i></li><li><i>72 = Integrations</i></li></ul>
    - `type` 1 | 2 | 3 — <p>Enum values:</p><ul><li><i>1 = Survey</i></li><li><i>2 = Nps</i></li><li><i>3 = Csat</i></li></ul>
    - `inputType` 1 | 2 — <p>Enum values:</p><ul><li><i>1 = Text</i></li><li><i>2 = Sound</i></li></ul>
    - `options` string, nullable
    - `sipServerId` integer
    - `createdDate` string, date-time
    - `links` SurveyLink[], nullable
      - `id` integer
      - `linkedId` integer
      - `linkedTable` 0 | 1 | 2 | 5 | 6 | 7 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 19 | 20 | 21 | 22 | 23 | 25 | 26 | 27 | 31 | 32 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 50 | 51 | 52 | 53 | 55 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | 68 | 69 | 72 — Infoset data objects<p>Enum values:</p><ul><li><i>0 = None</i></li><li><i>1 = Company</i></li><li><i>2 = Contacts</i></li><li><i>5 = Deals</i></li><li><i>6 = EmailLogs</i></li><li><i>7 = Emails</i></li><li><i>10 = MailAccounts</i></li><li><i>11 = MarketingLog</i></li><li><i>12 = MarketingSession</i></li><li><i>13 = MarketingTable</i></li><li><i>14 = Pipeline</i></li><li><i>15 = PipelineStages</i></li><li><i>16 = Todos</i></li><li><i>19 = TicketLogs</i></li><li><i>20 = Tickets</i></li><li><i>21 = Users</i></li><li><i>22 = Settings</i></li><li><i>23 = ContactGroups</i></li><li><i>25 = UserRights</i></li><li><i>26 = CustomUserRights</i></li><li><i>27 = UserGroups</i></li><li><i>31 = Automations</i></li><li><i>32 = Subjects</i></li><li><i>34 = Categories</i></li><li><i>35 = CallLogs</i></li><li><i>36 = Voicemails</i></li><li><i>37 = UserChannelRights</i></li><li><i>38 = CallCenterQueues</i></li><li><i>39 = DialPlans</i></li><li><i>40 = ServiceProviders</i></li><li><i>41 = IvrMenus</i></li><li><i>42 = IvrMenuDetails</i></li><li><i>43 = IvrPlugins</i></li><li><i>44 = VoipUsers</i></li><li><i>45 = DialerTable</i></li><li><i>46 = DialerSession</i></li><li><i>47 = DialerSessionLog</i></li><li><i>48 = DialerDtmfLink</i></li><li><i>50 = ChatRooms</i></li><li><i>51 = ChatTable</i></li><li><i>52 = ChatMessages</i></li><li><i>53 = ChatWidgets</i></li><li><i>55 = OutboundMessages</i></li><li><i>60 = ChatWidgetHomepage</i></li><li><i>61 = Chatbot</i></li><li><i>62 = ChatbotObject</i></li><li><i>63 = DealLogs</i></li><li><i>64 = SlaPolicies</i></li><li><i>65 = Sms</i></li><li><i>66 = Survey</i></li><li><i>67 = Announcements</i></li><li><i>68 = AnnouncementReadLogs</i></li><li><i>69 = AuditLogs</i></li><li><i>72 = Integrations</i></li></ul>

## Other responses

- `400` — Bad Request

---

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