Skip to main content
GET
Conversations List

Authorizations

api_access_token
string
header
required

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
team_id
integer
labels
string[]
page
integer
default:1

paginate through conversations

Response

Conversations retrieved successfully

success
boolean
required
Example:

true

data
object[]
required

Array of conversations

meta
object
required
message
string
required

Success message

Example:

"Conversations retrieved successfully"