Skip to main content
GET
List conversations

Query Parameters

accountId
string

Only conversations of this connected account. Leave it out for all accounts.

Text to look for in the person's name, in their handle, and in the last message.

scope
enum<string>

Which conversations to return.

  • all: open conversations.
  • unread: open conversations with unread messages.
  • needs_reply: open conversations where the other person wrote last.
  • pending: open conversations where you wrote last.
  • closed: closed conversations.
  • any: open and closed. Defaults to all.
Available options:
all,
unread,
needs_reply,
pending,
closed,
any
sort
enum<string>

Order by the time of the last message. Defaults to newest.

Available options:
newest,
oldest
tagId
string[]

Only conversations with this tag. Repeat the parameter to match several tags.

statusId
string[]

Only conversations in this status. Repeat the parameter to match several statuses.

limit
integer

How many items to return, from 1 to 100. Defaults to 50.

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

nextCursor from the previous page. A cursor only works with the filters it was issued for.

Response

OK. Check status: errors the API handles itself also return 200.

status
boolean
required

true when the request succeeded.

data
object
required
error
null
required

Always null on success.