GET/site

Get App WebApp Settings

Available for: Chatflow, Workflow, Agent, Chatbot, Legacy Agent, Text Generator apps.

Returns the branding and display settings for the app's hosted web app, such as its title, icon, theme colors, and default language.

2 status codes
200Web app settings of the application.
chat_color_themestringoptional
Chat color theme.
chat_color_theme_invertedbooleanoptional
Whether the chat color theme is inverted.
copyrightstringoptional
Copyright text.
custom_disclaimerstringoptional
Custom disclaimer text.
default_languagestringoptional
Default language code.
descriptionstringoptional
Web app description.
iconstringoptional
Icon content (emoji or image ID).
icon_backgroundstringoptional
Icon background color.
icon_typestringoptional
Type of icon used. `emoji` for emoji icons, `image` for uploaded image icons.
icon_urlstringoptional
URL of the icon image.
input_placeholderstringoptional
Placeholder text shown in the web app message input box. `null` when not configured.
privacy_policystringoptional
Privacy policy URL.
show_workflow_stepsbooleanoptional
Whether to show workflow steps.
titlestringoptional
Web app title.
use_icon_as_answer_iconbooleanoptional
Whether to use the app icon as the answer icon.
403`forbidden` : Site not found for this application or the workspace has been archived.

One documented failure

  • forbidden

    You don't have the permission to access the requested resource. It is either read-protected or not readable by the server.

    forbidden

Error handling

A 403 is returned: forbidden : Site not found for this application or the workspace has been archived.