APIList Banned Users API - Access Control | BotSubscription

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 TokenRequired

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.

Request
curl -X GET "https://api.botsubscription.com/v2/projects/YOUR_PROJECT_ID/ban?limit=10&offset=0" \
  -H "Authorization: Bearer YOUR_TOKEN"
Successapplication/json
{
  "ok": true,
  "request_id": "11111111-1111-1111-1111-111111111111",
  "method": "GET",
  "path": "/v2/projects/YOUR_PROJECT_ID/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": "Terms of service violation",
      "user_name": {
        "first_name": "John",
        "username": "johndoe"
      }
    }
  ]
}

Last updated: