Skip to main content
GET
List Chats

Authorizations

Authorization
string
header
required

Query Parameters

filter[external_id]
string

Filter by external ID (exact match)

filter[type]
enum<string>

Filter by chat type (chat or email)

Available options:
chat,
email
filter[title]
string

Filter by title (case-insensitive partial match)

filter[participant_name]
string

Filter by participant name (case-insensitive partial match)

filter[scorecard_id]
string[]

Filter by scorecard UUID(s) — returns chats evaluated with any of the given scorecards

filter[user_id]
string[]

Filter by user UUID(s)

filter[team_id]
string[]

Filter by team UUID(s)

from_date_time
string<date-time>

Start of date range filter (ISO 8601 format)

to_date_time
string<date-time>

End of date range filter (ISO 8601 format)

exclude_transcript
boolean
default:false

If true, omit transcript data from response to reduce payload size

page
integer
default:1

Page number for pagination (starts from 1)

Required range: x >= 1
size
integer
default:10

Number of items per page (min 1, max 50)

Required range: 1 <= x <= 50

Response

Chats successfully returned

data
object[]
meta
object
Example: