Skip to main content
GET
List conversations

Authorizations

Authorization
string
header
required

An API key from the console, starting ob_live_, sent as Authorization: Bearer <key>.

Query Parameters

channel
enum<string>
required

email or linkedin.

Available options:
email,
linkedin
pageSize
integer
default:25

Conversations per page.

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

The pagination.nextCursor of the page before. Later pages keep the first page's size.

Required string length: 1 - 200
folder
enum<string>

Email: inbox (the default), sent, unread, favorite, archived, spam or trash. LinkedIn: inbox (the default, every chat) or unread.

Available options:
inbox,
sent,
unread,
favorite,
archived,
spam,
trash
campaignId
string

Only the conversations of one campaign.

Required string length: 24
Pattern: ^[0-9a-fA-F]+$
since
string<date-time>

Only conversations with a message at or after this ISO 8601 date-time.

to
string<date-time>

Only conversations with a message at or before this ISO 8601 date-time, not before since.

Email: matches names, addresses, the subject and the text. LinkedIn: matches the other person's name.

Required string length: 1 - 200
mailbox
string

Email only: one mailbox, or up to 20 separated by commas.

Required string length: 1 - 6420
repliesOnly
boolean

Email only: true keeps the conversations where the other side wrote back.

accountId
string

LinkedIn only: one seat, by its id.

Required string length: 1 - 100

Response

One page of conversations, newest first.

data
object[]
required
pagination
object
required