Skip to main content
POST
Filter chat sessions
Each returned session includes all of its assigned tags, even when filtering by a subset of tag names. Each tag contains tag_name and created_at. 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.

Body

application/json
filters
object
sort_by
enum<string>

Sort field (default: last_message_at)

Available options:
last_message_at,
created_at
sort_order
enum<string>

Sort direction (default: desc)

Available options:
asc,
desc
page
integer
default:1

Page number (1-based, default: 1)

Required range: -9007199254740991 <= x <= 2147483647
limit
integer
default:25

Results per page (1-100, default: 25)

Required range: -9007199254740991 <= x <= 2147483647

Response

Default Response

data
object[]
required
page
number
required
limit
number
required
has_next
boolean
required
has_previous
boolean
required