Skip to main content
GET
Search Web Chat Threads

Authorizations

x-api-key
string
header
required

Path Parameters

agent_id
string<uuid> | null
required

Query Parameters

q
string
required

Search query

limit
integer
default:10

Number of search results to return

Required range: 1 <= x <= 50
offset
integer
default:0

Number of search results to skip

Required range: x >= 0
sort_by
string
default:newest

Sort by: 'newest' or 'oldest'

feedback_filter
string | null

Filter by feedback: 'any', 'positive', 'negative', or None for all

has_ticket
boolean | null

Filter threads that have a ticket ID

connected_to_platform
boolean | null

Filter threads that are connected to platform

Response

Successful Response

agent_id
string<uuid>
required
title
string
required
id
string<uuid> | null
user_id
string<uuid> | null
anon_user_id
string<uuid> | null
organization_id
string<uuid> | null
metadata
Metadata · object
created_at
string<date-time> | null
updated_at
string<date-time> | null
messages
ChatMessage · object[] | null
widget_user
WidgetUserData · object | null

Model for widget user data from the widget_user table.

message_count
integer
default:0
ticket_id
string | null
chat_history_parent_comment_id
string | null
connected_to_platform
boolean | null