Get widget settings

Fetch the embeddable widget's configuration and which sections it shows. Requires the admin scope.

GET

/api/v2/settings/widget

GET

/settings/widget

curl -X GET "https://productlane.com/api/v2/settings/widget" \
  -H "Authorization: Bearer $PRODUCTLANE_API_KEY"

Authorization

Authorization
string
header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

application/json

Successful response

enabled
boolean
required
widget_key
string
required
default_view
string
required
icon_type
string
required
icon_visible
boolean
required
size
string
required
branding_enabled
boolean
required
custom_styling_enabled
boolean
required
custom_links_enabled
boolean
required
custom_links_heading
string | null
required
contact_avatars_enabled
boolean
required
identity_verification_enabled
boolean
required
portal_auth_enabled
boolean
required
guest_chat_enabled
boolean
required
sections
object
required
updated_at
string
required

{
  "enabled": true,
  "widget_key": "string",
  "default_view": "string",
  "icon_type": "string",
  "icon_visible": true,
  "size": "string",
  "branding_enabled": true,
  "custom_styling_enabled": true,
  "custom_links_enabled": true,
  "custom_links_heading": "string",
  "contact_avatars_enabled": true,
  "identity_verification_enabled": true,
  "portal_auth_enabled": true,
  "guest_chat_enabled": true,
  "sections": {
    "changelog": true,
    "roadmap": true,
    "support": true,
    "help_center": true,
    "ai_chat": true,
    "live_chat": true,
    "feedback": true,
    "whats_new": true
  },
  "updated_at": "string"
}

{ "enabled": true, "widget_key": "string", "default_view": "string", "icon_type": "string", "icon_visible": true, "size": "string", "branding_enabled": true, "custom_styling_enabled": true, "custom_links_enabled": true, "custom_links_heading": "string", "contact_avatars_enabled": true, "identity_verification_enabled": true, "portal_auth_enabled": true, "guest_chat_enabled": true, "sections": { "changelog": true, "roadmap": true, "support": true, "help_center": true, "ai_chat": true, "live_chat": true, "feedback": true, "whats_new": true }, "updated_at": "string" }