Skip to main content
GET
List chat sessions
Each session includes tags, with each tag’s tag_name and created_at timestamp. Tags are ordered by name. Sessions without tags return an empty array. The support_team field contains the assigned support team’s id and name. The ID remains stable when the team is renamed. This field is null when no support team can be resolved for the session. The first_human_message_at field contains the first recorded human reply time as an ISO 8601 timestamp, or null when no human reply has been recorded. Internal notes and automated messages do not set this timestamp. Later human replies do not change it. The title field is the session title: the email subject, a subject set by an agent, or an AI-generated title. It is null until one is set. Use assignee to identify who is currently assigned to a session: A human assignee’s name matches the organization display name in GET /users. An organization name override takes precedence; a blank or missing override falls back to the account name. The name is null if the user is no longer a member of the organization or cannot be found; the recorded ID remains available for historical attribution. Reading a session does not require the users:read scope. Reading the user directory, including emails, does. The response field assignee_id is deprecated. Human IDs remain strings there; AI and unassigned sessions return null. Clients that previously used the AI placeholder must switch to assignee.type. Assignment requests continue to use assignee_id with a numeric human user ID or null to unassign.

Authorizations

Authorization
string
header
required

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

Query Parameters

cursor
string

Pagination cursor to fetch the next set of results

handed_off
boolean

Filter by handoff status. Use "true" or "false"

status
enum<string>

Filter by session status (open, closed_resolved, closed_unresolved)

Available options:
open,
closed_resolved,
closed_unresolved
channel_type
enum<string>
Available options:
web,
email,
phone_voice,
slack,
sms,
whatsapp,
instagram,
messenger,
api,
web_voice,
twitter,
twitter_mentions,
app_review,
internal
created_after
string

Filter sessions created after this ISO 8601 timestamp

created_before
string

Filter sessions created before this ISO 8601 timestamp

updated_after
string

Filter sessions updated after this ISO 8601 timestamp

updated_before
string

Filter sessions updated before this ISO 8601 timestamp

Response

Default Response

items
object[]
required
next
string | null
required