List Conversations
curl --request GET \
--url https://chat.botpress.cloud/{webhookUrl}/conversations \
--header 'x-user-key: <x-user-key>'import requests
url = "https://chat.botpress.cloud/{webhookUrl}/conversations"
headers = {"x-user-key": "<x-user-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-user-key': '<x-user-key>'}};
fetch('https://chat.botpress.cloud/{webhookUrl}/conversations', 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://chat.botpress.cloud/{webhookUrl}/conversations",
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-user-key: <x-user-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://chat.botpress.cloud/{webhookUrl}/conversations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-user-key", "<x-user-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://chat.botpress.cloud/{webhookUrl}/conversations")
.header("x-user-key", "<x-user-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://chat.botpress.cloud/{webhookUrl}/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-user-key"] = '<x-user-key>'
response = http.request(request)
puts response.read_body{
"conversations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"nextToken": "<string>"
}
}{
"conversations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"nextToken": "<string>"
}
}Returns a list of Conversation objects
GET
/
conversations
List Conversations
curl --request GET \
--url https://chat.botpress.cloud/{webhookUrl}/conversations \
--header 'x-user-key: <x-user-key>'import requests
url = "https://chat.botpress.cloud/{webhookUrl}/conversations"
headers = {"x-user-key": "<x-user-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-user-key': '<x-user-key>'}};
fetch('https://chat.botpress.cloud/{webhookUrl}/conversations', 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://chat.botpress.cloud/{webhookUrl}/conversations",
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-user-key: <x-user-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://chat.botpress.cloud/{webhookUrl}/conversations"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-user-key", "<x-user-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://chat.botpress.cloud/{webhookUrl}/conversations")
.header("x-user-key", "<x-user-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://chat.botpress.cloud/{webhookUrl}/conversations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-user-key"] = '<x-user-key>'
response = http.request(request)
puts response.read_body{
"conversations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"nextToken": "<string>"
}
}{
"conversations": [
{
"id": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"meta": {
"nextToken": "<string>"
}
}Headers
Authentication Key
Query Parameters
Provide the meta.nextToken value provided in the last API response to retrieve the next page of results
Response
Returns a list of Conversation objects
Last modified on March 24, 2026
Was this page helpful?
⌘I