Skip to main content
GET
Search conversations

Authorizations

api_access_token
string
header
required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

id
integer
required

The numeric ID of the account

Query Parameters

q
string
required

The search term.

Example:

"plans"

status
enum<string>

Restrict to one conversation status.

Available options:
open,
resolved,
pending,
snoozed,
all
assignee_type
enum<string>

Restrict by who it is assigned to.

Available options:
me,
unassigned,
all,
assigned
inbox_id
integer

Restrict to one inbox.

team_id
integer

Restrict to one team.

labels
string

Restrict to conversations carrying these label titles.

page
integer
default:1

The page parameter

Response

Success

meta
object

Match counts across the whole account, not just this page.

payload
object[]

The matching conversations.