Skip to main content
GET
Search conversations

Authorizations

X-API-KEY
string
header
required

Query Parameters

query
string

Words to search for.

Maximum string length: 100
channel
enum<string>

Only conversations that happened on this channel. A call the customer replied to by text counts as text too.

Available options:
phone,
text,
web_chat,
email
range
enum<string>

Created within this window. Every window starts at midnight in the team's timezone. Omit for all time.

Available options:
today,
yesterday,
7d,
14d,
30d,
90d,
365d,
mtd,
ytd
limit
integer
default:10

Results per page.

Required range: 1 <= x <= 50
page
integer
default:1

Page number. Use next_page from the previous response.

Required range: x >= 1

Response

One page of conversations.

total_matching
integer
Example:

214

page
integer
Example:

1

next_page
integer | null
Example:

2

conversations
object[]