---
title: "List connected WebSocket clients"
method: GET
path: "/v1/connected-clients"
tags: ["websocket-admin"]
---

# List connected WebSocket clients

`GET /v1/connected-clients`

## Request

- Base URL: `https://lpad-backend.stage.defi.ovh.gala.com`
- URL: `https://lpad-backend.stage.defi.ovh.gala.com/v1/connected-clients`
- Auth: one of:
  - API key in header `x-api-key`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/gala/apis/launchpad-backend-api/docs/v1/connected-clients/get.ts> (a function with typed inputs; its response is checked against the schema)

Get list of currently connected users (admin/overseer only)

## Query parameters

- `minConnectionSeconds` number
- `isOverseer` boolean
- `authenticated` boolean
- `userAddresses` string
- `userAddress` string
- `tokenName` string
- `limit` number
- `offset` number
- `room` string

## Response `200`

Connected clients, room statistics, and offset pagination in the success envelope.

- object
  - `error` false, required: Successful response marker.
  - `message` string, required: Response message.
  - `status` number, required: HTTP status code.
  - `data` ConnectedClientsResponseDto, required
    - `clients` ConnectedClientResponseDto[], required
      - `address` string
      - `authenticated` boolean, required
      - `connectedAt` string, date-time, required
      - `lastActivity` string, date-time, required
      - `rooms` string[], required
      - `socketId` string, required
      - `userAgent` string
    - `pagination` ConnectedClientsPaginationResponseDto, required
      - `hasMore` boolean, required
      - `limit` number, required
      - `offset` number, required
      - `total` number, required
    - `summary` ConnectedClientsSummaryResponseDto, required
      - `anonymousCount` number, required
      - `authenticatedCount` number, required
      - `overseerCount` number
      - `requestedUsersOnline` string[]
      - `roomCounts` object, required
      - `rooms` ConnectedRoomSummaryResponseDto[], required
        - `authenticatedCount` number, required
        - `connectedCount` number, required
        - `room` string, required
      - `totalConnected` number, required

## Other responses

- `400`: Invalid query parameters
- `401`: Unauthorized - missing or invalid JWT/API key
- `403`: Forbidden - user is not admin or overseer
- `500`: Internal server error - failed to list clients
- `default`: Shared error envelope for connected-client lookup failures.

---

[API](https://skmtc.dev/gala/apis/launchpad-backend-api.md) - [All operations](https://skmtc.dev/gala/apis/launchpad-backend-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gala/apis/launchpad-backend-api/revisions/74545971be2b?raw)
