API Documentation

REST API for notifications via Telegram and Max. Subscribers, OTP, broadcasts, forms, helpdesk.

Subscribers

Manage subscriber list and their tags.

GET /v1/subscribers

Project subscriber list. Pagination via query parameters.

limit number

Number of records (default 50, max 200)

offset number

Offset from the beginning of the list (default 0)

channel string

Filter by channel: telegram or max

Response

{
"subscribers": [
{
"id": "550e8400-...",
"channel": "telegram",
"first_name": "John",
"username": "johndoe",
"lang": "ru",
"tags": ["vip"],
"created_at": "2026-03-05T12:00:00Z"
}
],
"total": 150
}

PUT /v1/subscribers/:id/tags

Update subscriber tags. Pass the full array of tags. Tags must be pre-created in project settings or via API. Unknown tags will be auto-created (if the 20-tag limit is not reached).

PUT /v1/subscribers/sub_abc/tags
 
{
"tags": ["vip", "beta"]
}

Response

{
"updated": true
}

Related sections