cURL
curl --request GET \
--url https://api.botpress.cloud/v1/tables/{table} \
--header 'Authorization: Bearer <token>' \
--header 'x-bot-id: <x-bot-id>'import requests
url = "https://api.botpress.cloud/v1/tables/{table}"
headers = {
"x-bot-id": "<x-bot-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-bot-id': '<x-bot-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.botpress.cloud/v1/tables/{table}', 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.botpress.cloud/v1/tables/{table}",
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>",
"x-bot-id: <x-bot-id>"
],
]);
$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.botpress.cloud/v1/tables/{table}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-bot-id", "<x-bot-id>")
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.botpress.cloud/v1/tables/{table}")
.header("x-bot-id", "<x-bot-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botpress.cloud/v1/tables/{table}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-bot-id"] = '<x-bot-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"table": {
"id": "<string>",
"name": "<string>",
"schema": {
"properties": {},
"additionalProperties": true,
"type": "object",
"$schema": "<string>",
"required": [
"<string>"
]
},
"factor": 1,
"frozen": true,
"keyColumn": "<string>",
"tags": {},
"isComputeEnabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"rows": 123,
"stale": 123,
"indexing": 123
}{
"table": {
"id": "<string>",
"name": "<string>",
"schema": {
"properties": {},
"additionalProperties": true,
"type": "object",
"$schema": "<string>",
"required": [
"<string>"
]
},
"factor": 1,
"frozen": true,
"keyColumn": "<string>",
"tags": {},
"isComputeEnabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"rows": 123,
"stale": 123,
"indexing": 123
}getTable
Retrieves detailed information about a specific table, identified by its name or unique identifier.
GET
/
v1
/
tables
/
{table}
cURL
curl --request GET \
--url https://api.botpress.cloud/v1/tables/{table} \
--header 'Authorization: Bearer <token>' \
--header 'x-bot-id: <x-bot-id>'import requests
url = "https://api.botpress.cloud/v1/tables/{table}"
headers = {
"x-bot-id": "<x-bot-id>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-bot-id': '<x-bot-id>', Authorization: 'Bearer <token>'}
};
fetch('https://api.botpress.cloud/v1/tables/{table}', 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.botpress.cloud/v1/tables/{table}",
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>",
"x-bot-id: <x-bot-id>"
],
]);
$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.botpress.cloud/v1/tables/{table}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-bot-id", "<x-bot-id>")
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.botpress.cloud/v1/tables/{table}")
.header("x-bot-id", "<x-bot-id>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.botpress.cloud/v1/tables/{table}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-bot-id"] = '<x-bot-id>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"table": {
"id": "<string>",
"name": "<string>",
"schema": {
"properties": {},
"additionalProperties": true,
"type": "object",
"$schema": "<string>",
"required": [
"<string>"
]
},
"factor": 1,
"frozen": true,
"keyColumn": "<string>",
"tags": {},
"isComputeEnabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"rows": 123,
"stale": 123,
"indexing": 123
}{
"table": {
"id": "<string>",
"name": "<string>",
"schema": {
"properties": {},
"additionalProperties": true,
"type": "object",
"$schema": "<string>",
"required": [
"<string>"
]
},
"factor": 1,
"frozen": true,
"keyColumn": "<string>",
"tags": {},
"isComputeEnabled": true,
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"rows": 123,
"stale": 123,
"indexing": 123
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Bot id
Integration id
Integration alias
Integration name
User Id
User Role
Path Parameters
The table's name or unique identifier for targeting specific table operations.
Response
Details of the requested table, including row count and indexing status.
Last modified on March 20, 2026
Was this page helpful?
⌘I