Skip to main content
GET
/
users
List Users
curl --request GET \
  --url https://api.example.com/users \
  --header 'X-API-Key: <api-key>'
{
  "items": [
    {
      "id": 123,
      "status": "<string>",
      "language": "<string>",
      "balance_kopeks": 123,
      "balance_rubles": 123,
      "has_had_paid_subscription": true,
      "has_made_first_topup": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "telegram_id": 123,
      "username": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "referral_code": "<string>",
      "referred_by_id": 123,
      "last_activity": "2023-11-07T05:31:56Z",
      "promo_group": {
        "id": 123,
        "name": "<string>",
        "server_discount_percent": 123,
        "traffic_discount_percent": 123,
        "device_discount_percent": 123,
        "apply_discounts_to_addons": true
      },
      "subscription": {
        "id": 123,
        "status": "<string>",
        "actual_status": "<string>",
        "is_trial": true,
        "start_date": "2023-11-07T05:31:56Z",
        "end_date": "2023-11-07T05:31:56Z",
        "traffic_limit_gb": 123,
        "traffic_used_gb": 123,
        "device_limit": 123,
        "autopay_enabled": true,
        "autopay_days_before": 123,
        "subscription_url": "<string>",
        "subscription_crypto_link": "<string>",
        "connected_squads": [
          "<string>"
        ]
      }
    }
  ],
  "total": 123,
  "limit": 123,
  "offset": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.bedolagam.ru/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Query Parameters

​
limit
integer
default:50
Required range: 1 <= x <= 200
​
offset
integer
default:0
Required range: x >= 0
​
status
enum<string> | null
Available options:
active,
blocked,
deleted
​
promo_group_id
integer | null
​
search
string | null

Response

Successful Response

​
items
UserResponse · object[]
required
​
total
integer
required
​
limit
integer
required
​
offset
integer
required