Conversations
Get a conversation
GET
/conversations/{conversationId}One conversation with its messages, oldest first.
Try itSend a real request with your API key
Path
conversationIdstringRequiredThe conversation.
Answer
200 OK The conversation.
dataConversationRequiredInside it
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
Errors
- 401 Unauthorized
unauthorized - 404 Not found
not_foundnot_in_campaign - 429 Too many requests
rate_limited - 500 Server error
server_error
Every error has the same shape. See Errors.