Skip to main content
GET
List an assistant's sessions

Authorizations

Authorization
string
header
required

Project API key (sk_api_…).

Path Parameters

realtimeAssistantId
string<uuid>
required

Query Parameters

channel
enum<string>
Available options:
web,
telephony,
whatsapp
direction
enum<string>

Web sessions are always inbound — the user opens them.

Available options:
inbound,
outbound
state
enum<string>
Available options:
created,
dispatched,
dialing,
ringing,
answered,
active,
completed,
failed
from
string<date-time>

Inclusive lower bound on createdAt. Compared as a raw string against the ISO-8601 UTC timestamps in the response, so a non-ISO value silently shifts or voids the range instead of erroring.

to
string<date-time>

Inclusive upper bound on createdAt, same format as from.

limit
integer
default:50

Sessions read per page before filtering. Values above the maximum are clamped, not rejected.

Required range: 1 <= x <= 100
cursor
string

The previous page's nextCursor, passed back unchanged. Treat it as opaque.

assistantAlias
enum<string>

draft lists only sessions launched on the draft. prod lists everything else, including sessions launched by an exact version number and sessions from before versions existed.

Available options:
prod,
draft
include_summary
boolean
default:false

Adds each call's summary to its row, up to about 1 KB each. Must be exactly true or false, anything else is a 400. A row with no summary leaves the key out: a call that never connected, one not summarised yet, or one from before summaries.

Response

One page of sessions, newest first.

sessions
object[]
nextCursor
string

Present while more pages exist.