curl --request GET \
--url https://api.gleap.io/v3/messages \
--header 'Authorization: Bearer <token>' \
--header 'project: <project>'import requests
url = "https://api.gleap.io/v3/messages"
headers = {
"project": "<project>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {project: '<project>', Authorization: 'Bearer <token>'}
};
fetch('https://api.gleap.io/v3/messages', 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.gleap.io/v3/messages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"project: <project>"
],
]);
$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.gleap.io/v3/messages"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("project", "<project>")
req.Header.Add("Authorization", "Bearer <token>")
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.gleap.io/v3/messages")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "507f1f77bcf86cd799439015",
"ticket": "507f1f77bcf86cd799439011",
"type": "TEXT",
"data": {
"content": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "This is a sample message content."
}
]
}
]
}
},
"comment": "This is a sample message content.",
"bot": false,
"user": {
"id": "507f1f77bcf86cd799439012",
"email": "support@example.com",
"firstName": "John",
"lastName": "Doe"
},
"session": {
"_id": "507f1f77bcf86cd799439013",
"id": "507f1f77bcf86cd799439013",
"email": "user@example.com"
},
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"index": 0
},
{
"id": "507f1f77bcf86cd799439016",
"ticket": "507f1f77bcf86cd799439011",
"type": "TEXT",
"data": {
"content": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Thank you for the update!"
}
]
}
]
}
},
"comment": "Thank you for the update!",
"bot": false,
"user": {
"id": "507f1f77bcf86cd799439017",
"email": "user@example.com",
"firstName": "Jane",
"lastName": "Smith"
},
"session": {
"_id": "507f1f77bcf86cd799439013",
"id": "507f1f77bcf86cd799439013",
"email": "user@example.com"
},
"createdAt": "2024-01-15T11:00:00.000Z",
"updatedAt": "2024-01-15T11:00:00.000Z",
"index": 1
}
]Find messages by query
Get messages by query with support for filtering and pagination.
Filtering:
- Filter by ticket:
ticket=507f1f77bcf86cd799439011. Any identifierGET /tickets/{ticketId}accepts works here too — the human-facing ticket number shown in the dashboard (ticket=143790), the 24-char ObjectId, or the shareToken. - Filter by type:
type=TEXTortype=TEXT,NOTE(comma-separated values match any; bracket syntax such astype[$in]=...is NOT supported) - Filter by bot messages:
bot=trueorbot=false - Filter by date range:
createdAt>=2024-01-01&createdAt<=2024-12-31
Ordering: Messages are always returned oldest-first (ascending createdAt); the sort order is not
configurable.
Pagination:
- Cursor mode (recommended): pass
paginated=trueto receive{ items, hasMore, nextBefore }; passbefore=<messageId>(the previousnextBefore) to fetch the next older page.skipis ignored in this mode;limitdefaults to 30 and is clamped to 1-100. - Legacy mode (no
paginated): returns a flat array;limitdefaults to 1000 and values above 100 are clamped to 100;skipis applied.
Exporting a full conversation:
Filter by ticket rather than by bot. bot=true selects messages exchanged with the AI bot, so on a
conversation that was handed over to a human it omits the agent’s replies — ticket={ticketId} returns
the complete transcript. Thread replies are not part of the main feed either; fetch them per message with
GET /messages/{messageId}/thread. Which conversations still exist is governed by retention — AI-only
(type=BOT) conversations are deleted about 33 days after they are created, see GET /tickets.
Ticket history:
Since August 2026 this endpoint returns conversation messages only. Audit entries — FEEDBACK_UPDATED
(status, assignee, team, priority, type, tag, title changes, …) and workflow/system entries — are no
longer part of the response; filtering by those types returns an empty result. Fetch them from
GET /tickets/{ticketId}/history, which returns them in the same message-compatible shape.
Translation:
language=esreturns messages translated into the given language. Requires the project setting ‘translate customer messages’; only conversation messages (TEXT,USER_TEXT,NOTE,BOT,BOT_REPLY,SHARED_COMMENT) are translated, and messages already in the target language are returned unchanged.
curl --request GET \
--url https://api.gleap.io/v3/messages \
--header 'Authorization: Bearer <token>' \
--header 'project: <project>'import requests
url = "https://api.gleap.io/v3/messages"
headers = {
"project": "<project>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {project: '<project>', Authorization: 'Bearer <token>'}
};
fetch('https://api.gleap.io/v3/messages', 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.gleap.io/v3/messages",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"project: <project>"
],
]);
$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.gleap.io/v3/messages"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("project", "<project>")
req.Header.Add("Authorization", "Bearer <token>")
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.gleap.io/v3/messages")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/messages")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "507f1f77bcf86cd799439015",
"ticket": "507f1f77bcf86cd799439011",
"type": "TEXT",
"data": {
"content": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "This is a sample message content."
}
]
}
]
}
},
"comment": "This is a sample message content.",
"bot": false,
"user": {
"id": "507f1f77bcf86cd799439012",
"email": "support@example.com",
"firstName": "John",
"lastName": "Doe"
},
"session": {
"_id": "507f1f77bcf86cd799439013",
"id": "507f1f77bcf86cd799439013",
"email": "user@example.com"
},
"createdAt": "2024-01-15T10:30:00.000Z",
"updatedAt": "2024-01-15T10:30:00.000Z",
"index": 0
},
{
"id": "507f1f77bcf86cd799439016",
"ticket": "507f1f77bcf86cd799439011",
"type": "TEXT",
"data": {
"content": {
"type": "doc",
"content": [
{
"type": "paragraph",
"content": [
{
"type": "text",
"text": "Thank you for the update!"
}
]
}
]
}
},
"comment": "Thank you for the update!",
"bot": false,
"user": {
"id": "507f1f77bcf86cd799439017",
"email": "user@example.com",
"firstName": "Jane",
"lastName": "Smith"
},
"session": {
"_id": "507f1f77bcf86cd799439013",
"id": "507f1f77bcf86cd799439013",
"email": "user@example.com"
},
"createdAt": "2024-01-15T11:00:00.000Z",
"updatedAt": "2024-01-15T11:00:00.000Z",
"index": 1
}
]Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Query Parameters
- Set to
truefor cursor mode: returns{ items, hasMore, nextBefore }
- Cursor for the next older page (the previous response's
nextBefore); only withpaginated=true
- Maximum number of messages to return. Cursor mode: default 30, clamped to 1-100. Legacy mode: default 1000, values above 100 are clamped to 100.
- Deprecated, accepted and ignored. Ticket-history entries are served by
GET /tickets/{ticketId}/history.
Response
Ok