api.botsubscription.com

GET/v1/endpoint

AuthenticationBearer

Token

Stays in this tab. Required for this endpoint — the value below is what gets sent.

Path parameters0

Query parameters0

BodyJSON

Mock

curl --request GET \
  --url https://api.botsubscription.com/v1/endpoint \
  --header 'Authorization: Bearer sk_live_•••'

Get Setting - Fetch Configuration Value via API

Fetch the current value of a single configuration option. Use this when you need to check one specific setting without retrieving the entire configuration object. Common keys include default_language, timezone_preference, and collect_email_on_subscribe.

GET/v2/projects/{project_id}/settings/{key}

Authorization

Bearer TokenRequired

Path Parameters

project_idstringrequired

The unique identifier of the project.

keystringrequired

The setting key (e.g., default_language, timezone_preference, policies).

curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/settings/default_language" \
  -H "Authorization: Bearer YOUR_TOKEN"

const project_id = 'YOUR_PROJECT_ID';
const key = 'default_language';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/settings/${key}`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_TOKEN'
  }
});
const data = await response.json();

import requests
 
project_id = 'YOUR_PROJECT_ID'
key = 'default_language'
response = requests.get(
    f'https://api.botsubscription.com/v2/projects/{project_id}/settings/{key}',
    headers={'Authorization': 'Bearer YOUR_TOKEN'}
)
data = response.json()

$project_id = 'YOUR_PROJECT_ID';
$key = 'default_language';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/settings/{$key}");
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_TOKEN']);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);

Successapplication/json

{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/YOUR_PROJECT_ID/settings/default_language",
  "code": 200,
  "message": "Settings retrieved successfully",
  "data": {
    "default_language": "en"
  }
}

Setting not foundapplication/json

{
  "ok": false,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/YOUR_PROJECT_ID/settings/invalid_key",
  "code": 404,
  "error": {
    "error_code": "NOT_FOUND",
    "message": "Setting not found: invalidKey"
  }
}

Last updated: May 28, 2026