curl --request GET \
--url https://your-instance.example.com/admin/settings \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/admin/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.example.com/admin/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/admin/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/admin/settings",
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>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"createdAt": "<string>",
"debugMode": true,
"email": "<string>",
"id": "<string>",
"idpId": "<string>",
"isActive": true,
"logLevel": "<string>",
"mediaAutoPersist": true,
"metadata": {},
"msgRateLimit": 123,
"name": "<string>",
"plan": "<string>",
"rateLimit": 123,
"s3Bucket": "<string>",
"s3Endpoint": "<string>",
"s3Region": "<string>",
"sessionLimit": 123,
"updatedAt": "<string>"
}{
"error": "internal server error"
}{
"docs": "<string>",
"error": "<string>"
}Get instance settings
Returns the current instance configuration
curl --request GET \
--url https://your-instance.example.com/admin/settings \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-instance.example.com/admin/settings', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://your-instance.example.com/admin/settings"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-instance.example.com/admin/settings"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://your-instance.example.com/admin/settings",
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>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}{
"createdAt": "<string>",
"debugMode": true,
"email": "<string>",
"id": "<string>",
"idpId": "<string>",
"isActive": true,
"logLevel": "<string>",
"mediaAutoPersist": true,
"metadata": {},
"msgRateLimit": 123,
"name": "<string>",
"plan": "<string>",
"rateLimit": 123,
"s3Bucket": "<string>",
"s3Endpoint": "<string>",
"s3Region": "<string>",
"sessionLimit": 123,
"updatedAt": "<string>"
}{
"error": "internal server error"
}{
"docs": "<string>",
"error": "<string>"
}Authorizations
Scoped API key created via POST /api/account/keys.
Response
OK
When the tenant account was created
Whether debug mode is enabled for verbose logging
Tenant email address
Unique tenant identifier
Identity provider subject ID (from JWT)
Whether the tenant account is active
Logging verbosity: "debug", "info", "warn", "error"
Whether to automatically persist incoming media to S3
Custom key-value metadata for the tenant
Messages per minute limit
Tenant display name
Subscription plan (e.g. "free", "pro", "enterprise")
API requests per minute limit
S3 bucket name for media storage
S3-compatible endpoint URL for media storage
AWS region code (e.g. "us-east-1")
Maximum number of concurrent WhatsApp sessions
When the tenant account was last updated