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 Banned Users - View Blocked Members in Your Bot

Get a list of all members currently blocked from your Telegram or Discord community. Each record includes the ban timestamp, reason (if provided), and the user's profile information so you can review and manage access restrictions effectively.

GET/v2/projects/{project_id}/ban

Authorization

Bearer API KeyRequired

API key scope: ban:read (required for restricted keys).

Path Parameters

project_idstringrequired

The unique identifier of the project.

Query Parameters

limitintegerDefault: 10

Number of items per page.

offsetintegerDefault: 0

Number of items to skip.

curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/ban?limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_API_KEY"

const project_id = 'YOUR_PROJECT_ID';
const response = await fetch(`https://api.botsubscription.com/v2/projects/${project_id}/ban?limit=10&offset=0`, {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY'
  }
});
const data = await response.json();

import requests
 
project_id = 'YOUR_PROJECT_ID'
response = requests.get(
    f'https://api.botsubscription.com/v2/projects/{project_id}/ban',
    params={'limit': 10, 'offset': 0},
    headers={'Authorization': 'Bearer YOUR_API_KEY'}
)
data = response.json()

$project_id = 'YOUR_PROJECT_ID';
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.botsubscription.com/v2/projects/{$project_id}/ban?limit=10&offset=0");
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/ban",
  "code": 200,
  "total": 1,
  "limit": 10,
  "offset": 0,
  "data": [
    {
      "user_id": "123456789012345678",
      "banned_at": "2025-01-10T14:30:00.000Z",
      "banned_by": null,
      "banned_reason": null,
      "user_name": {
        "first_name": "John",
        "username": "johndoe"
      },
      "banned_by_user_name": {
        "first_name": "Alex",
        "last_name": "Example",
        "username": "alex_example"
      }
    }
  ]
}

Invalid page limitapplication/json

{
  "ok": false,
  "request_id": "44444444-4444-4444-8444-444444444444",
  "method": "GET",
  "path": "/v2/projects/11111111-1111-4111-8111-111111111111/ban",
  "code": 422,
  "errors": [
    {
      "message": "query: limit is too small; minimum allowed is 1",
      "error_code": "VALIDATION_ERROR"
    }
  ]
}

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/ban",
  "code": 401,
  "error": {
    "message": "Invalid or expired authentication token.",
    "error_code": "UNAUTHORIZED"
  }
}

Last updated: November 4, 2026