Get conversation with messages
Returns a full conversation thread with all messages in chronological order. Messages include sent emails, lead replies, and manual messages. Also includes any pending/sending/failed scheduled replies.
curl -X GET "https://api.sendkit.ai/v1/inbox/example_string" \
-H "Content-Type: application/json" \
-H "X-Api-Key: YOUR_API_KEY"
import requests
import json
url = "https://api.sendkit.ai/v1/inbox/example_string"
headers = {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
response = requests.get(url, headers=headers)
print(response.json())
const response = await fetch("https://api.sendkit.ai/v1/inbox/example_string", {
method: "GET",
headers: {
"Content-Type": "application/json",
"X-Api-Key": "YOUR_API_KEY"
}
});
const data = await response.json();
console.log(data);
package main
import (
"fmt"
"net/http"
)
func main() {
req, err := http.NewRequest("GET", "https://api.sendkit.ai/v1/inbox/example_string", nil)
if err != nil {
panic(err)
}
req.Header.Set("Content-Type", "application/json")
req.Header.Set("X-Api-Key", "YOUR_API_KEY")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
fmt.Println("Response Status:", resp.Status)
}
require 'net/http'
require 'json'
uri = URI('https://api.sendkit.ai/v1/inbox/example_string')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
request = Net::HTTP::Get.new(uri)
request['Content-Type'] = 'application/json'
request['X-Api-Key'] = 'YOUR_API_KEY'
response = http.request(request)
puts response.body
{
"success": true,
"data": {
"id": "664a1b2c3d4e5f6a7b8c9d0e",
"lead": {
"_id": "664a1b2c3d4e5f6a7b8c9d01",
"email": "jane@example.com",
"firstName": "Jane",
"lastName": "Doe",
"companyName": "Acme Inc",
"jobTitle": "VP of Sales"
},
"campaign": {
"_id": "664a1b2c3d4e5f6a7b8c9d02",
"name": "Q1 Outreach"
},
"status": "active",
"aiTag": "interested",
"tags": [
"vip"
],
"isRead": true,
"unreadCount": 0,
"messages": [
{
"type": "sent",
"subject": "Quick question about Acme's growth plans",
"body": "<p>Hi Jane, I noticed Acme recently...</p>",
"sentAt": "2024-05-28T10:00:00.000Z",
"sequenceStep": 1,
"opened": true,
"clicked": false
},
{
"type": "reply",
"from": "jane@example.com",
"to": "sales@mycompany.com",
"subject": "Re: Quick question about Acme's growth plans",
"content": "Thanks for reaching out! I'd love to learn more.",
"htmlContent": "<p>Thanks for reaching out! I'd love to learn more.</p>",
"receivedAt": "2024-06-01T14:30:00.000Z",
"isFromLead": true,
"isAutoReply": false,
"read": true,
"attachments": [
{
"filename": "proposal.pdf",
"contentType": "application/pdf",
"size": 245000,
"downloadUrl": "/v1/inbox/664a1b2c3d4e5f6a7b8c9d0e/attachments/0"
}
]
}
],
"scheduledReplies": [
{
"_id": "664a1b2c3d4e5f6a7b8c9d10",
"message": "Great to hear! Let's schedule a call...",
"scheduledFor": "2024-06-02T09:00:00.000Z",
"status": "pending",
"mailboxId": "664a1b2c3d4e5f6a7b8c9d03",
"createdAt": "2024-06-01T15:00:00.000Z"
}
]
}
}
{
"error": "Not Found",
"message": "The requested resource was not found",
"code": 404
}
/v1/inbox/{conversationId}Target server for requests. Edit to use your own host.
Platform API key (sk_user_...) or Workspace API key (sk_...)
Conversation ID (the inbox thread ID)
Request Preview
Response
Response will appear here after sending the request
Authentication
API Key for authentication. Platform API key (sk_user_...) or Workspace API key (sk_...)
Path Parameters
Conversation ID (the inbox thread ID)
Responses
Whether all lead replies have been read
Number of unread lead replies
All messages in chronological order
sent = outbound email, reply = inbound/outbound reply, manual = manually sent
sentreplymanualPresent for type=sent
Present for type=reply and type=manual
HTML version of reply content
Sender email (for replies)
Recipient email (for replies)
Campaign sequence step number (for sent emails)
Whether the sent email was opened
Whether a link in the sent email was clicked
Whether the reply is from the lead (vs from user)
Whether the reply is an auto-reply / OOO
Whether the reply has been read
Direction of manual message
File attachments on this message (replies and manual messages only)
Original filename
MIME type
File size in bytes
Relative URL to download this attachment (available when provider attachment IDs exist)
Pending/sending/failed scheduled replies
pendingsendingfailed