List Squads

Get list of all squads with local database info.

GET /cabinet/admin/remnawave/squads

List Squads

cURL

curl --request GET \
  --url https://api.example.com/cabinet/admin/remnawave/squads \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "uuid": "<string>",
      "name": "<string>",
      "members_count": 123,
      "inbounds_count": 123,
      "inbounds": [
        {}
      ],
      "local_id": 123,
      "display_name": "<string>",
      "country_code": "<string>",
      "is_available": true,
      "is_trial_eligible": true,
      "price_kopeks": 123,
      "max_users": 123,
      "current_users": 123,
      "is_synced": false
    }
  ],
  "total": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200 - application/json

Successful Response

List of squads response.

items · SquadWithLocalInfo · object[] · required

Show child attributes

total · integer · required