> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Chat Topic Entity

> Gets a ChatTopicEntity object.

NsApiSlow threshold: 5000 ms.



## OpenAPI

````yaml /openapi/agent/openapi-v3-ChatAgent.json post /api/v1/Agents/Chat/GetChatTopicEntity
openapi: 3.0.0
info:
  version: v1-Agents
  title: SuperOffice Agent API v1
  description: SuperOffice Agent API - ChatAgent
  contact:
    name: SuperOffice DevNet
    url: https://docs.superoffice.com/en/api/index.html
    email: sdk@superoffice.com
servers:
  - url: http://localhost:56350
  - url: https://localhost:56350
security: []
tags: []
externalDocs:
  description: >-
    The SuperOffice DevNet Community has more documentation, examples, and
    discussion forums.
  url: https://community.superoffice.com/en/developer/
paths:
  /api/v1/Agents/Chat/GetChatTopicEntity:
    post:
      tags:
        - Chat_Agent
      summary: Get Chat Topic Entity
      description: |-
        Gets a ChatTopicEntity object.

        NsApiSlow threshold: 5000 ms.
      operationId: v1ChatAgent_GetChatTopicEntity
      parameters:
        - name: chatTopicEntityId
          in: query
          description: The identifier of the ChatTopicEntity object
          required: true
          schema:
            format: int32
            type: integer
        - name: $select
          in: query
          description: >-
            Optional comma separated list of properties to include in the
            result. Other fields are then nulled out to reduce payload size:
            "Name,department,category". Default = show all fields.
          required: false
          schema:
            type: string
        - name: Accept-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code.
          required: false
          schema:
            type: string
        - name: SO-Language
          in: header
          description: >-
            Convert string references and multi-language values into a specified
            language (iso2) code. Overrides Accept-Language value.
          required: false
          schema:
            type: string
        - name: SO-Culture
          in: header
          description: >-
            Number, date formatting in a specified culture (iso2 language) code.
            Partially overrides SO-Language/Accept-Language value. Ignored if no
            Language set.
          required: false
          schema:
            type: string
        - name: SO-TimeZone
          in: header
          description: >-
            Specify the timezone code that you would like date/time responses
            converted to.
          required: false
          schema:
            type: string
        - name: SO-AppToken
          in: header
          description: >-
            The application token that identifies the partner app. Used when
            calling Online WebAPI from a server.
          required: false
          schema:
            type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatTopicEntity'
            text/json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatTopicEntity'
            application/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatTopicEntity'
            text/xml:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatTopicEntity'
            application/json-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatTopicEntity'
            application/merge-patch+json:
              schema:
                $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatTopicEntity'
      security:
        - SuperOffice_Password: []
          SuperId_Authentication: []
components:
  schemas:
    SuperOffice.CRM.Services.ChatTopicEntity:
      description: "Chat topics define who is assigned, when the channel is open for business, and look of the chat widget.\r\n<para />\r\nCarrier object for ChatTopicEntity.\r\nServices for the ChatTopicEntity Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IChatAgent\">Chat Agent</see>."
      type: object
      properties:
        ChatTopicId:
          format: int32
          description: The primary key (auto-incremented)
          type: integer
        Name:
          description: The name of this chat topic
          type: string
        Description:
          description: The descriptiong for this topic.
          type: string
        WelcomeMessage:
          description: >-
            The welcome message sent to the customer when the chat session
            starts.
          type: string
        Language:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.CustomerLanguage'
        LastAccept:
          format: date-time
          description: The last time a session was accepted from the inside for this topic.
          type: string
        SecondsPrAccept:
          format: int32
          description: The average number of seconds per accept for this topic.
          type: integer
        AlertRecipient:
          description: The recipient(s) for the alert template
          type: string
        AlertTemplate:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.ReplyTemplate'
        CollectConsent:
          description: Collect consent to store from user
          type: boolean
        BadgeHeader:
          description: The badge header of the chat topic
          type: string
        CustomQueueTextEnabled:
          description: Use the custom queue message text
          type: boolean
        CustomQueueText:
          description: >-
            A text to be used in the queue message in the chat widget. Usage is
            controlled by the flags field, bit number 3
          type: string
        WarnNewChatMinutes:
          format: int32
          description: Contains the user notify time in minutes
          type: integer
        WarnManagerNewChatMinutes:
          format: int32
          description: Contains the manager notify time in minutes
          type: integer
        TicketEnabled:
          description: Enable ticket submission in offline mode
          type: boolean
        TicketCategory:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketCategory'
        TicketPriority:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.TicketPriority'
        OpeningHoursEnabled:
          description: Whether to use opening hours or not.
          type: boolean
        OpeningHours:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatOpeningHours'
        Widget:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatWidgetSettings'
        BotEnabled:
          description: Enable chatbot on this topic. Run the trigger scripts on bot events.
          type: boolean
        BotSettings:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.ChatBotSettings'
        OfflineCollectConsent:
          description: Collect offline consent to store from user
          type: boolean
        WarnChatMessageMinutes:
          format: int32
          description: Contains the user notify time in minutes for new chat messages
          type: integer
        WarnManagerChatMessageMinutes:
          format: int32
          description: Contains the manager notify time in minutes for new chat messages
          type: integer
        UseQueueOfflineForm:
          description: Use offline form capability from chat queue
          type: boolean
        OfflineFormTimeLimit:
          format: int32
          description: >-
            The number of minutes in the queue before the offline form is
            available
          type: integer
        OfflineFormQueueLength:
          format: int32
          description: >-
            The number of customers in the queue before the offline form is
            available
          type: integer
        WidgetEnableRating:
          description: Enable rating functionality in the chat widgte
          type: boolean
        WidgetRatingText:
          description: The text to be displayed in the widget next to the rating stars
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.CustomerLanguage:
      description: "Customer languages that customer center supports.\r\n<para />\r\nCarrier object for CustomerLanguage.\r\nServices for the CustomerLanguage Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The List Item Id
          type: integer
        Value:
          description: The List Item Value
          type: string
        Tooltip:
          description: The List Item Tooltip
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.ReplyTemplate:
      description: "Reply template item\r\n<para />\r\nCarrier object for ReplyTemplate.\r\nServices for the ReplyTemplate Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ICustomerServiceAgent\">CustomerService Agent</see>."
      type: object
      properties:
        ReplyTemplateId:
          format: int32
          description: The primary key (auto-incremented)
          type: integer
        Name:
          description: The name for this reply template.
          type: string
        Description:
          description: The description for this reply template.
          type: string
        FolderId:
          format: int32
          description: >-
            The id of the folder in which this reply template is located. NULL
            or -1 if this is a toplevel reply template.
          type: integer
    SuperOffice.CRM.Services.TicketCategory:
      description: "Ticket Category - light read-only version of TicketCategoryEntity.\r\n<para />\r\nCarrier object for TicketCategory.\r\nServices for the TicketCategory Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The List Item Id
          type: integer
        Value:
          description: The List Item Value
          type: string
        Tooltip:
          description: The List Item Tooltip
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.TicketPriority:
      description: "Carrier object for TicketPriority.\r\nServices for the TicketPriority Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IListAgent\">List Agent</see>."
      type: object
      properties:
        Id:
          format: int32
          description: The List Item Id
          type: integer
        Value:
          description: The List Item Value
          type: string
        Tooltip:
          description: The List Item Tooltip
          type: string
        TableRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.TableRight'
        FieldProperties:
          description: >-
            Field property dictionary mapping field names to field access
            rights.
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldProperty'
    SuperOffice.CRM.Services.ChatOpeningHours:
      description: "Chat Topic Opening Hours\r\n<para />\r\nCarrier object for ChatOpeningHours.\r\nServices for the ChatOpeningHours Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IChatAgent\">Chat Agent</see>."
      type: object
      properties:
        TzLocation:
          $ref: '#/components/schemas/SuperOffice.CRM.TimeZoneData'
        MonEnabled:
          description: Whether open on Mondays.
          type: boolean
        MonStart:
          description: When opening hours start on Mondays. Only time-part is used.
          type: string
        MonStop:
          description: When opening hours stop on Mondays. Only time-part is used.
          type: string
        TueEnabled:
          description: Whether open on Tuesdays.
          type: boolean
        TueStart:
          description: When opening hours start on Tuesdays. Only time-part is used.
          type: string
        TueStop:
          description: When opening hours stop on Tuesdays. Only time-part is used.
          type: string
        WedEnabled:
          description: Whether open on Wednesdays.
          type: boolean
        WedStart:
          description: When opening hours start on Wednesdays. Only time-part is used.
          type: string
        WedStop:
          description: When opening hours stop on Wednesday. Only time-part is used.
          type: string
        ThuEnabled:
          description: Whether open on Thursdays.
          type: boolean
        ThuStart:
          description: When opening hours start on Thursdays. Only time-part is used.
          type: string
        ThuStop:
          description: When opening hours stop on Thursdays. Only time-part is used.
          type: string
        FriEnabled:
          description: Whether open on Fridays.
          type: boolean
        FriStart:
          description: When opening hours start on Fridays. Only time-part is used.
          type: string
        FriStop:
          description: When opening hours stop on Fridays. Only time-part is used.
          type: string
        SatEnabled:
          description: Whether open on Saturdays.
          type: boolean
        SatStart:
          description: When opening hours start on Saturdays. Only time-part is used.
          type: string
        SatStop:
          description: When opening hours stop on Saturdays. Only time-part is used.
          type: string
        SunEnabled:
          description: Whether open on Sundays.
          type: boolean
        SunStart:
          description: When opening hours start on Sundays. Only time-part is used.
          type: string
        SunStop:
          description: When opening hours stop on Sundays. Only time-part is used.
          type: string
        UseLunchHours:
          description: Whether to use lunch hours or not.
          type: boolean
        LunchStart:
          description: When opening hours starts for lunch. Only time-part is used.
          type: string
        LunchStop:
          description: When opening hours stops for lunch. Only time-part is used.
          type: string
    SuperOffice.CRM.Services.ChatWidgetSettings:
      description: "Defines the look of the chat widget.\r\n<para />\r\nCarrier object for ChatWidgetSettings.\r\nServices for the ChatWidgetSettings Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IChatAgent\">Chat Agent</see>."
      type: object
      properties:
        AutoFaqEnabled:
          description: Enable automatic FAQ suggestions
          type: boolean
        AutoFaqCategory:
          $ref: '#/components/schemas/SuperOffice.CRM.Services.KbCategory'
        PreFormEnabled:
          description: Enable pre-chat form for anonymous users
          type: boolean
        PreFormMessage:
          description: Message to be shown in a pre-chat
          type: string
        RequiredFields:
          description: Fields required to start a chat
          enum:
            - None
            - Email
            - Name
            - Company
            - Phone
            - Country
          type: string
        PostFormEnabled:
          description: Enable post chat form
          type: boolean
        PostFormHeader:
          description: Header text to show in post chat form
          type: string
        PostFormMessage:
          description: Message text to show in post chat form
          type: string
        PostTranscriptEnabled:
          description: Enable transcript of chat session
          type: boolean
        LanguageIsoCode:
          description: The language ISO code for the widget language
          type: string
        Size:
          description: 'Chat widget size: normal or large.'
          enum:
            - Normal
            - Large
          type: string
        Theme:
          description: Predefined themes for the chat widget
          enum:
            - Classic
            - Modern
          type: string
        Color:
          description: The base color of the widget
          type: string
        BadgeColor:
          description: Optional color for chat widget badge
          type: string
        BadgeTextColor:
          description: Optional color for chat widget badge text
          type: string
        CustMsgColor:
          description: Optional color for chat widget customer message
          type: string
        CustMsgTextColor:
          description: Optional color for chat widget customer message text
          type: string
        AgentMsgColor:
          description: Optional color for chat widget agent message
          type: string
        AgentMsgTextColor:
          description: Optional color for chat widget agent message text
          type: string
        ButtonColor:
          description: Optional color for chat widget button
          type: string
        ButtonTextColor:
          description: Optional color for chat widget button text
          type: string
        Font:
          description: The font used in the widget
          type: string
        FontSize:
          description: Optional size for chat widget font
          type: string
        LogoEnabled:
          description: Indicates if the logo should be shown in the widget
          type: boolean
        LogoBlobId:
          format: int32
          description: Blob id that contains logo image
          type: integer
        LogoName:
          description: filename/description of logo (from blob)
          type: string
        ShowAgentPhoto:
          description: Use agent photo and name when chatting
          type: boolean
        WelcomeTitle:
          description: Short welcome message when user initiates a chat
          type: string
        WelcomeMessage:
          description: Short message displayed as long as the request is in queue or active
          type: string
        OfflineHeader:
          description: Offline text shown in widget header
          type: string
        OfflineMessage:
          description: Offline message shown in widget
          type: string
        OfflineFields:
          description: Required field when creating ticket in offline mode
          enum:
            - None
            - Email
            - Name
            - Company
            - Phone
            - Country
          type: string
        UseAgentFirstname:
          description: Whether to use the firstname of the agent in the chat widget.
          type: boolean
    SuperOffice.CRM.Services.ChatBotSettings:
      description: "Chat Topic bot settings. Trigger script ids to run on bot events\r\n<para />\r\nCarrier object for ChatBotSettings.\r\nServices for the ChatBotSettings Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.IChatAgent\">Chat Agent</see>."
      type: object
      properties:
        BotName:
          description: Chatbot name
          type: string
        BotRegisterScriptId:
          format: int32
          description: Script id to register/unregister chatbot. 0 if there is no bot
          type: integer
        BotSessionCreatedScriptId:
          format: int32
          description: Script id to run on new session.
          type: integer
        BotSessionChangedScriptId:
          format: int32
          description: Script id to run when session state changes.
          type: integer
        BotMessageReceivedScriptId:
          format: int32
          description: Script id to run when new messages received from customer.
          type: integer
    SuperOffice.CRM.Security.TableRight:
      description: "Wraps a table right together with an explanatory reason.\r\nCode can indicate why access is restricted."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.Security.FieldProperty:
      description: >-
        Class holding properties like field length, field type about a field in
        the carrier.
      type: object
      properties:
        FieldRight:
          $ref: '#/components/schemas/SuperOffice.CRM.Security.FieldRight'
        FieldType:
          type: string
        FieldLength:
          format: int32
          description: ''
          type: integer
    SuperOffice.CRM.TimeZoneData:
      type: object
      properties:
        TZLocationID:
          format: int32
          description: Timezone location ID - primary key.
          type: integer
        Name:
          description: >-
            Name associated with the location: Country name + region name,
            Norway, United States - Alaska
          type: string
        TZLocationCode:
          description: "Code associated with location: UTC, AR-NQ, AU-QLD, PF2A\r\nNot the an ISO country code. Unique."
          type: string
        TZLocationCities:
          description: 'Cities associated with location: Oslo, London, Rio de Janeiro'
          type: string
        IsoNumber:
          format: int32
          description: 'Country ISO code associated with location: 578'
          type: integer
        TimeZoneSTDRules:
          description: Dictionary of standard rules
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.TimeZoneRule'
        TimeZoneDSTRules:
          description: Dictionary of Daylight saving time rules
          type: object
          additionalProperties:
            $ref: '#/components/schemas/SuperOffice.CRM.TimeZoneRule'
    SuperOffice.CRM.Services.KbCategory:
      description: "Knowledge base category. Groups knowledge base articles into hierarchy.\r\n<para />\r\nCarrier object for KbCategory.\r\nServices for the KbCategory Carrier is available from the <see cref=\"T:SuperOffice.CRM.Services.ICustomerServiceAgent\">CustomerService Agent</see>."
      type: object
      properties:
        KbCategoryId:
          format: int32
          description: The primary key (auto-incremented)
          type: integer
        Name:
          description: The name of this category.
          type: string
        Description:
          description: The description of this category.
          type: string
        Fullname:
          description: The full name of this category, i.e. Foo/bar/test.
          type: string
        ParentId:
          format: int32
          description: >-
            This entry contains a reference to the parent category. NULL or -1
            if this is a toplevel category.
          type: integer
        SortOrder:
          format: int32
          description: >-
            A strictly ascending number used for sorting categories when they
            are listed.
          type: integer
    SuperOffice.CRM.Security.FieldRight:
      description: "Wraps the field right together with an explanatory reason.\r\nAlso adds logical operators to the field rights so that they can be easily combined."
      type: object
      properties:
        Mask:
          type: string
        Reason:
          type: string
    SuperOffice.CRM.TimeZoneRule:
      type: object
      properties:
        StartDay:
          format: int32
          type: integer
        StartMonth:
          format: int32
          type: integer
        EndDay:
          format: int32
          type: integer
        EndMonth:
          format: int32
          type: integer
        TZOffset:
          format: int32
          type: integer
        StartRulePattern:
          type: string
        EndRulePattern:
          type: string

````

## Related topics

- [Get Chat Topic Entity](/en/api/reference/restful/rest/chattopic/get-chat-topic-entity.md)
- [NSChatAgent](/en/automation/crmscript/reference/CRMScript.NetServer.NSChatAgent.md)
- [SuperOffice.WebApi.Data.ChatTopicEntity](/en/api/reference/webapi/SuperOffice.WebApi.Data.ChatTopicEntity.md)
- [SuperOffice.WebApi.Agents.ChatAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.ChatAgent.md)
- [SuperOffice.WebApi.Agents.IChatAgent](/en/api/reference/webapi/SuperOffice.WebApi.Agents.IChatAgent.md)
- [NSChatTopicEntity](/en/automation/crmscript/reference/CRMScript.NetServer.NSChatTopicEntity.md)