Get one thread on an inbox
curl --request GET \
--url https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId} \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}"
headers = {"x-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-token': '<api-key>'}};
fetch('https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}")
.header("x-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"threadId": "<string>",
"subject": "<string>",
"status": "closed",
"isJunk": "archived",
"unread": true,
"assigneeId": "<string>",
"type": "<string>",
"participants": [
"<string>"
],
"labels": [
{
"id": "<string>",
"name": "<string>"
}
],
"metrics": {
"firstResponseHrs": 123,
"avgResponseHrs": 123,
"responseCount": 123,
"reopened": true,
"touchCount": 123,
"inboundCount": 123,
"outboundCount": 123,
"lastMessageAt": "2023-11-07T05:31:56Z",
"lastMessageDirection": "in"
},
"messages": [
{
"messageId": "<string>",
"threadId": "<string>",
"subject": "<string>",
"body": "<string>",
"type": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"direction": "in",
"from": {},
"to": [
{}
],
"sentByUser": "<string>",
"sentVia": "aptly"
}
]
}
}Inboxes
Get one thread on an inbox
Returns one thread in the same shape as an entry of
GET /api/inboxes/{channelId}/threads: its messages and stored per-thread
metrics. Message body is the stored snippet; use the message endpoint
below for the full body and attachments.
Junk threads are returned too, since the thread is asked for by id. A thread that belongs to another inbox returns 404.
GET
/
api
/
inboxes
/
{channelId}
/
threads
/
{threadId}
Get one thread on an inbox
curl --request GET \
--url https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId} \
--header 'x-token: <api-key>'import requests
url = "https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}"
headers = {"x-token": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-token': '<api-key>'}};
fetch('https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-token", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}")
.header("x-token", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://core-api.getaptly.com/api/inboxes/{channelId}/threads/{threadId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-token"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"threadId": "<string>",
"subject": "<string>",
"status": "closed",
"isJunk": "archived",
"unread": true,
"assigneeId": "<string>",
"type": "<string>",
"participants": [
"<string>"
],
"labels": [
{
"id": "<string>",
"name": "<string>"
}
],
"metrics": {
"firstResponseHrs": 123,
"avgResponseHrs": 123,
"responseCount": 123,
"reopened": true,
"touchCount": 123,
"inboundCount": 123,
"outboundCount": 123,
"lastMessageAt": "2023-11-07T05:31:56Z",
"lastMessageDirection": "in"
},
"messages": [
{
"messageId": "<string>",
"threadId": "<string>",
"subject": "<string>",
"body": "<string>",
"type": "<string>",
"timestamp": "2023-11-07T05:31:56Z",
"direction": "in",
"from": {},
"to": [
{}
],
"sentByUser": "<string>",
"sentVia": "aptly"
}
]
}
}