Skip to main content
GET
/
api
/
chats
List tracked chats
curl --request GET \
  --url http://localhost:8080/api/chats \
  --header 'Authorization: Bearer <token>'
[
  {
    "id": 123,
    "bot_id": 123,
    "title": "<string>",
    "type": "<string>",
    "username": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "message_count": 123
  }
]

Authorizations

Authorization
string
header
required

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

Query Parameters

bot_id
integer
required

Bot ID whose chats to list

Response

Array of chats

id
integer

Telegram chat ID

bot_id
integer

ID of the bot tracking this chat

title
string

Chat title or name

type
string

Chat type (private, group, supergroup, channel)

username
string

Chat username if public

first_name
string

First name (for private chats)

last_name
string

Last name (for private chats)

message_count
integer

Number of tracked messages