Перейти к основному содержанию
GET
/
api
/
users
/
list
List users
curl --request GET \
  --url http://localhost:8080/api/users/list \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "username": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "is_bot": true
  }
]

Авторизации

Authorization
string
header
обязательно

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

Параметры запроса

chat_id
integer
обязательно

Chat ID

q
string

Search query (matches username or name)

limit
integer
по умолчанию:50
offset
integer
по умолчанию:0

Ответ

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