curl --request GET \
--url https://api.example.com/api/conversations/{route_name}/transcript \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/conversations/{route_name}/transcript"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/conversations/{route_name}/transcript', 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://api.example.com/api/conversations/{route_name}/transcript",
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-api-key: <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://api.example.com/api/conversations/{route_name}/transcript"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://api.example.com/api/conversations/{route_name}/transcript")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/conversations/{route_name}/transcript")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"client_address": "<string>",
"created_at": 123,
"door": "api",
"inbound_text": "<string>",
"message_id": "<string>",
"origin": "client",
"route_name": "<string>",
"thread_id": "<string>",
"updated_at": 123,
"answer": "<string>",
"answer_parts": [
{
"data": {
"options": {},
"values": {}
},
"footer": "<string>",
"header": {
"kind": "image",
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
},
"location": {
"latitude": 123,
"longitude": 123,
"address": "<string>",
"name": "<string>"
},
"media": [
{
"kind": "image",
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
],
"message": "",
"options": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"pages": [
{
"fields": [
"<string>"
],
"title": "<string>"
}
],
"schema": {},
"sections": [
{
"rows": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"title": "<string>"
}
],
"template": {
"language": "<string>",
"name": "<string>",
"body_parameters": [
"<string>"
],
"buttons": [
{
"payload": "<string>",
"kind": "quick_reply"
}
],
"header_media": {
"kind": "image",
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
}
}
],
"answer_status": "answered",
"attempts": 123,
"callback_url": "<string>",
"caller_principal": "<string>",
"channel": "<string>",
"delivery_status": "pending_delivery",
"error": "<string>",
"inbound_attachments": [
{
"kind": "image",
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
],
"inbound_event": {},
"inbound_form": {},
"inbound_kind": "message",
"inbound_locale": "<string>",
"inbound_location": {
"latitude": 123,
"longitude": 123,
"address": "<string>",
"name": "<string>"
},
"our_identity": "<string>",
"outbound_message_ids": [
"<string>"
],
"provider_message_id": "<string>",
"submitted_by": "<string>"
}
],
"next_page": 123,
"order": "<string>",
"page": 123,
"page_size": 123,
"total": 123,
"truncated": true
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Read a conversation thread's transcript
One thread’s records under route_name, one page at a time.
order picks the direction: asc (the default) reads the transcript oldest first,
desc reads it newest first, which is the order a live tail wants because page 1 then
always holds the latest messages. page/page_size window that order from its own
end, so page 1 of desc is the newest page and never the oldest.
q filters to records whose inbound text or answer contains that substring — a BOUNDED
scan (the searched text lives inside the record content blob), so a page that spent its
scan budget answers truncated: true LOUDLY. A q read never 404s: the unknown-thread
404 below is gated on an UNFILTERED read, so under q an unknown thread and one that
matched nothing alike read as an EMPTY page.
An admin reads whole records; a non-admin reads the caller-safe projection, which
withholds the internal detail of the route key’s run. An unknown route_name is a loud
404. A thread that is absent or keyed to another route answers the uniform thread
not-found. A page or page_size below 1, a page above the served maximum, a
blank thread_id or an unknown order is a 400.
A thread the index still holds but whose rows have expired under the retention TTL is
NOT that 404: it reads as an empty page carrying the indexed total, until the prune
pass reclaims the members and the thread becomes unknown.
Returns {"items", "total", "page", "page_size", "next_page", "order", "truncated"},
where total counts the thread’s indexed records for an unfiltered read, or the matches
a bounded q scan found.
curl --request GET \
--url https://api.example.com/api/conversations/{route_name}/transcript \
--header 'x-api-key: <api-key>'import requests
url = "https://api.example.com/api/conversations/{route_name}/transcript"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://api.example.com/api/conversations/{route_name}/transcript', 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://api.example.com/api/conversations/{route_name}/transcript",
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-api-key: <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://api.example.com/api/conversations/{route_name}/transcript"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<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://api.example.com/api/conversations/{route_name}/transcript")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/api/conversations/{route_name}/transcript")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": {
"items": [
{
"client_address": "<string>",
"created_at": 123,
"door": "api",
"inbound_text": "<string>",
"message_id": "<string>",
"origin": "client",
"route_name": "<string>",
"thread_id": "<string>",
"updated_at": 123,
"answer": "<string>",
"answer_parts": [
{
"data": {
"options": {},
"values": {}
},
"footer": "<string>",
"header": {
"kind": "image",
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
},
"location": {
"latitude": 123,
"longitude": 123,
"address": "<string>",
"name": "<string>"
},
"media": [
{
"kind": "image",
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
],
"message": "",
"options": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"pages": [
{
"fields": [
"<string>"
],
"title": "<string>"
}
],
"schema": {},
"sections": [
{
"rows": [
{
"text": "<string>",
"description": "<string>",
"id": "<string>",
"kind": "reply"
}
],
"title": "<string>"
}
],
"template": {
"language": "<string>",
"name": "<string>",
"body_parameters": [
"<string>"
],
"buttons": [
{
"payload": "<string>",
"kind": "quick_reply"
}
],
"header_media": {
"kind": "image",
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
}
}
],
"answer_status": "answered",
"attempts": 123,
"callback_url": "<string>",
"caller_principal": "<string>",
"channel": "<string>",
"delivery_status": "pending_delivery",
"error": "<string>",
"inbound_attachments": [
{
"kind": "image",
"url": "<string>",
"caption": "<string>",
"filename": "<string>"
}
],
"inbound_event": {},
"inbound_form": {},
"inbound_kind": "message",
"inbound_locale": "<string>",
"inbound_location": {
"latitude": 123,
"longitude": 123,
"address": "<string>",
"name": "<string>"
},
"our_identity": "<string>",
"outbound_message_ids": [
"<string>"
],
"provider_message_id": "<string>",
"submitted_by": "<string>"
}
],
"next_page": 123,
"order": "<string>",
"page": 123,
"page_size": 123,
"total": 123,
"truncated": true
}
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}{
"error": "<string>",
"code": "<string>"
}Authorizations
Path Parameters
Query Parameters
1-based page number, in the requested order.
1 <= x <= 1000000Items per page. A larger value is capped to 200, never refused.
x >= 1The thread to read, as the send door returned it.
1\Sasc reads the transcript oldest first; desc is the live-tail order.
asc, desc Optional text filter — keep only records whose inbound text or answer contains this substring (a BOUNDED scan, so a filtered page may report truncated).
Response
Success.
A page of a thread's records (admin full records or the caller_view subset).
order is the direction served; next_page is null on the last page.
Show child attributes
Show child attributes

