Search conversation sessions

Search for conversation sessions with filtering and pagination support. Returns session details including metadata, message counts, call summaries, and more. Set includeMessages to receive the messages of every returned conversation in the same response. Available from version 260.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
projectIds
array of strings | null

Optional list of project IDs to filter conversations. If absent, searches all projects in the company

projectIds
sessionIds
array of strings | null

Optional list of session IDs (external or internal session IDs) to get specific sessions

sessionIds
string | null

A pagination token returned by the API. To fetch subsequent pages, provide the nextCursor value exactly as it was returned in the previous request. Leave this field empty to fetch the beginning of the list.

integer | null
1 to 1000

Maximum number of results per response. Defaults to 50 if not specified. When includeMessages is true the maximum is 50

date-time

Search messages from this timestamp (ISO8601 format with timezone)

date-time

Search messages to this timestamp (ISO8601 format with timezone)

string
enum

Sort by field. Default is StartTime

Allowed:
string
enum

Sort order. Default is Asc

Allowed:
recordingStatus
array of objects | null

Optional filter restricting results to sessions whose audio recording lifecycle status is in the given set. If absent, no lifecycle filter is applied.

recordingStatus
Allowed:
boolean | null
Defaults to false

When true, every result carries its messages in the messages field, at most 100 per conversation. Limits the maximum limit to 50. Defaults to false. Available from version 265.

boolean | null
Defaults to false

When true, BotLog events (entries produced by the dialog Log block) are included in botOutput.events of the returned messages. Only applies when includeMessages is true. Defaults to false. Available from version 265.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json