Skip to main content
GET
Conversations List

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

assignee_type
enum<string>
default:all

Filter conversations by assignee type.

Available options:
me,
unassigned,
all,
assigned
status
enum<string>
default:open

Filter by conversation status.

Available options:
all,
open,
resolved,
pending,
snoozed
q
string

Filters conversations with messages containing the search term

inbox_id
integer

Restrict to one inbox.

team_id
integer

Restrict to one team.

labels
string[]

Restrict to conversations carrying these label titles. Repeat as labels[]=vip&labels[]=urgent.

page
integer
default:1

paginate through conversations

Response

Success

data
object

The conversation list is nested under data, one level deeper than most list endpoints.