Skip to main content
GET
List users

Authorizations

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

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