Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

An org API key (gh_live_…) from Settings → API keys in the console.

Query Parameters

q
string
Maximum string length: 100
waiting
enum<string>

approval: only conversations with an open approval or question.

Available options:
approval
source
enum<string>

phone: only phone calls; chat: everything but phone calls.

Available options:
phone,
chat
agent_id
string

Only conversations with this agent.

object
string

Only conversations the AI ontology says were about this object (an object type's or a kind's id, device) or property (device.serial_number). Conversations are tagged a few minutes after they go quiet.

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

next_cursor from the previous page.

include
string

total_count adds how many match across every page.

Example:

"total_count"

Response

200 - application/json

A page of conversations.

data
object[]
has_more
boolean
next_cursor
string | null
total_count
integer

How many match the filters across every page. Only with include=total_count.