Conversations
List conversations
GET
/conversationsConversations the inbox shows, newest first. Inbox privacy applies.
Try itSend a real request with your API key
Query
limitintegerDefaults to
50.cursorstringnextCursor from the previous page.
updatedSincestring · date-timeleadIdstringcampaignIdstring
Answer
200 OK A page of conversations.
dataarray of ConversationRequiredEach item
idstringRequiredleadobject or nullRequiredInside it
idstringfullNamestringlinkedinUrlstring
senderobject or nullRequiredInside it
idstringnamestring
channelstringRequiredOne of
linkedin,inmail.campaignsarray of objectRequiredEach item
idstringRequiredThe campaign's ID.
namestringRequiredThe campaign's name.
unreadbooleanRequiredarchivedbooleanRequiredtagsarray of stringRequiredlastMessageone ofRequiredInside it
One of these shapes:
Option 1
idstringRequireddirectionstringRequiredOne of
inbound,outbound.textstringRequiredUp to 500 characters.
sentAtstring · date-timeRequired
Option 2
messageCountintegerRequiredupdatedAtstring · date-timeRequiredlinkstring · uriRequiredOpens the conversation in Salesteam.
messagesarray of MessageOnly on GET /conversations/{conversationId}, oldest first.
Each item
idstringRequireddirectionstringRequiredOne of
inbound,outbound.textstringRequiredsubjectstringInMail only.
sentAtstring · date-timeRequired
nextCursorstring or nullRequiredPass as
cursorfor the next page; null on the last page.
Errors
- 400 Bad request
invalid_requestinvalid_jsonduplicate_in_request - 401 Unauthorized
unauthorized - 429 Too many requests
rate_limited - 500 Server error
server_error
Every error has the same shape. See Errors.