List Users

Lists users who have sent messages in a chat, with optional search.

GET /api/users/list

List users

cURL

curl --request GET \
  --url http://localhost:8080/api/users/list \
  --header 'Authorization: Bearer <token>'

200

[
  {
    "id": 123,
    "username": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "is_bot": true
  }
]

Authorizations

BearerAuthCookieAuth

Authorization · string · header · required

API key with bmx_ prefix. Obtain via /api/auth/api-keys.

Query Parameters

chat_id · integer · required

Chat ID

q · string

Search query (matches username or name)

limit · integer · default: 50

offset · integer · default: 0

Response

200

application/json

Array of users

id · integer

Telegram user ID

username · string

Telegram username (without @)

first_name · string

First name

last_name · string

Last name

is_bot · boolean

Whether this user is a bot