Get Workspace Settings
curl --request GET \
--url https://api.example.com/v1/settingsimport requests
url = "https://api.example.com/v1/settings"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/settings', 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/v1/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/v1/settings"
req, _ := http.NewRequest("GET", url, nil)
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/v1/settings")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"workspace_id": "<string>",
"name": "<string>",
"slug": "<string>",
"timezone": "<string>",
"locale": "<string>",
"currency": "<string>",
"jurisdiction": "<string>",
"billing": {},
"features": {},
"branding": {},
"retention": {},
"created_at": "<string>"
}
}Settings
Get Workspace Settings
Return high-level workspace configuration - branding, defaults, locale, and feature flags
GET
/
v1
/
settings
Get Workspace Settings
curl --request GET \
--url https://api.example.com/v1/settingsimport requests
url = "https://api.example.com/v1/settings"
response = requests.get(url)
print(response.text)const options = {method: 'GET'};
fetch('https://api.example.com/v1/settings', 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/v1/settings",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
]);
$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/v1/settings"
req, _ := http.NewRequest("GET", url, nil)
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/v1/settings")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/v1/settings")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
response = http.request(request)
puts response.read_body{
"data": {
"workspace_id": "<string>",
"name": "<string>",
"slug": "<string>",
"timezone": "<string>",
"locale": "<string>",
"currency": "<string>",
"jurisdiction": "<string>",
"billing": {},
"features": {},
"branding": {},
"retention": {},
"created_at": "<string>"
}
}Request
Returns a snapshot of workspace configuration relevant to API integrations. For per-user preferences, use the Users endpoint instead.Query Parameters
None.Headers
Authorization: Bearer wbk_your_api_key_here
Response
object
Show properties
Show properties
string
Workspace UUID
string
Workspace display name
string
URL-safe slug (e.g.
acme-legal)string
IANA timezone (e.g.
Europe/Berlin)string
BCP 47 locale (e.g.
en-GB, de-DE)string
ISO 4217 currency code (e.g.
EUR)string
ISO 3166-1 alpha-2 default jurisdiction
object
plan, seats, credits_balance, trial_ends_atobject
Feature flag map (e.g.
lexi_autoresearch: true)object
primary_color, logo_url, accent_colorobject
Data retention policy:
audit_log_days, soft_delete_daysstring
ISO 8601 workspace creation timestamp
X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset, and X-Request-ID.
curl https://data.leadlex.com/functions/v1/api-gateway/v1/settings \
-H "Authorization: Bearer wbk_your_api_key_here"
import requests
API_KEY = "wbk_your_api_key_here"
BASE_URL = "https://data.leadlex.com/functions/v1/api-gateway"
r = requests.get(
f"{BASE_URL}/v1/settings",
headers={"Authorization": f"Bearer {API_KEY}"},
)
settings = r.json()["data"]
print(settings["name"], settings["timezone"], settings["billing"]["plan"])
const res = await fetch(
'https://data.leadlex.com/functions/v1/api-gateway/v1/settings',
{ headers: { Authorization: 'Bearer wbk_your_api_key_here' } },
);
const { data } = await res.json();
console.log(data.name, data.timezone);
Example Response
{
"data": {
"workspace_id": "ws_01HY1",
"name": "Acme Legal",
"slug": "acme-legal",
"timezone": "Europe/Berlin",
"locale": "de-DE",
"currency": "EUR",
"jurisdiction": "DE",
"billing": {
"plan": "growth",
"seats": 8,
"credits_balance": 4840,
"trial_ends_at": null
},
"features": {
"lexi_autoresearch": true,
"lexi_chat_stream": true,
"document_ai": true
},
"branding": {
"primary_color": "#0f5845",
"logo_url": "https://cdn.leadlex.com/tenants/acme/logo.png",
"accent_color": "#ff7a00"
},
"retention": {
"audit_log_days": 365,
"soft_delete_days": 30
},
"created_at": "2026-02-11T09:00:00Z"
}
}
Errors
| Status | Code | Description |
|---|---|---|
| 401 | invalid_key | Invalid or expired API key |
| 403 | insufficient_permissions | Missing read:settings permission |
| 429 | rate_limited | Rate limit exceeded |