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

Headers0

BodyJSON

Examples

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

List Admin Permissions

Get the complete list of permission scopes you can assign to administrators. BotSubscription uses granular permissions to control what each admin can view and modify—from managing plans and memberships to accessing analytics and configuring settings.

GET/v2/projects/{project_id}/admins/permissions

Authorization

Bearer API KeyRequired

API key access: Unrestricted project API key required. Restricted keys cannot call this endpoint.

Path Parameters

project_idstringrequired

The unique identifier of the project.

curl -X GET "https://api.botsubscription.com/v2/projects/f47ac10b-58cc-4372-a567-0e02b2c3d479/admins/permissions" \
  -H "Authorization: Bearer YOUR_API_KEY"

const project_id = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/admins/permissions`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();

import requests
 
project_id = 'f47ac10b-58cc-4372-a567-0e02b2c3d479'
response = requests.get(
    f'https://api.botsubscription.com/v2/projects/{project_id}/admins/permissions',
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()

$project_id = 'f47ac10b-58cc-4372-a567-0e02b2c3d479';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/admins/permissions");
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer YOUR_API_KEY']);
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/11111111-1111-4111-8111-111111111111/admins/permissions",
  "code": 200,
  "total": 80,
  "message": "Permissions fetched successfully",
  "data": [
    "admins:add",
    "admins:edit",
    "admins:read",
    "admins:update",
    "agent:manage",
    "agent:reply",
    "all",
    "backups:create",
    "backups:read",
    "backups:restore",
    "ban:add",
    "ban:read",
    "ban:remove",
    "coupons:add",
    "coupons:delete",
    "coupons:read",
    "coupons:update",
    "documents:delete",
    "documents:read",
    "memberships:add",
    "memberships:admin",
    "memberships:delete",
    "memberships:read",
    "memberships:update",
    "memberships:write",
    "merchant-accounts:add",
    "merchant-accounts:delete",
    "merchant-accounts:read",
    "merchant-accounts:update",
    "payment-requests:add",
    "payment-requests:read",
    "payment-requests:update",
    "payment_methods:add",
    "payment_methods:delete",
    "payment_methods:read",
    "payment_methods:update",
    "payments:read",
    "payments:write",
    "plans:add",
    "plans:delete",
    "plans:edit",
    "plans:manage",
    "plans:read",
    "plans:update",
    "settings.appearance:delete",
    "settings.appearance:read",
    "settings.appearance:write",
    "settings.community:delete",
    "settings.community:read",
    "settings.community:write",
    "settings.integrations:delete",
    "settings.integrations:read",
    "settings.integrations:write",
    "settings.notifications:delete",
    "settings.notifications:read",
    "settings.notifications:write",
    "settings.sales:delete",
    "settings.sales:read",
    "settings.sales:write",
    "settings.welcome:delete",
    "settings.welcome:read",
    "settings.welcome:write",
    "settings:delete",
    "settings:read",
    "settings:update",
    "settings:write",
    "subscriptions:add",
    "subscriptions:cancel",
    "subscriptions:delete",
    "subscriptions:read",
    "targets:add",
    "targets:delete",
    "targets:read",
    "targets:update",
    "users:read",
    "users:update",
    "view_analytics",
    "webhooks:create",
    "webhooks:delete",
    "webhooks:read"
  ]
}

Invalid or expired API keyapplication/json

{
  "ok": false,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/admins/permissions",
  "code": 401,
  "error": {
    "message": "Invalid or expired authentication token.",
    "error_code": "UNAUTHORIZED"
  }
}

Last updated: November 4, 2026