Skip to content
VIDMOATDocs

List bot users

GEThttps://api.vidmoat.com/v1/telegram/users
Bearer tokenScope telegram.users.readFreeTry it in the playground

The people who used the bot, 25 a page. Search with q (name, @username or id), sort=last_seen or spend.

Query parameters#

  • qstring
    Search by Telegram id, @username or name.
  • sortenumdefault last_seen
    spend is highest 30-day credits first.
    One of last_seen, spend
  • pageintegerdefault 1
    1-based page number.

Response#

Returns 200.

Response fields#

  • objectstring
    list.
  • dataarray
    People.
    Show 15 child fields
    • objectstring
      Always telegram_user.
    • idstring or null
      Vidmoat id of the person. null for somebody who has not used the bot yet.
    • telegram_user_idstring or null
      Numeric Telegram id, as a string.
    • usernamestring or null
      Telegram @username, without the @.
    • display_namestring or null
      Their Telegram name.
    • statusenum
      Whether they are blocked.
      One of active, blocked
    • allowlistedboolean
      On the bot's allowlist.
    • daily_creditsinteger or null
      Their own daily credit limit. null means the bot's default.
    • first_seen_atstring or null
      ISO 8601 time of their first message.
    • last_seen_atstring or null
      ISO 8601 time of their latest message.
    • projectsinteger
      Projects they have. Omitted for somebody who has not used the bot.
    • messages_todayinteger
      Since midnight UTC. Omitted for somebody who has not used the bot.
    • messages_30dinteger
      Last 30 days. Omitted for somebody who has not used the bot.
    • credits_todayinteger
      Credits spent since midnight UTC. Omitted for somebody who has not used the bot.
    • credits_30dinteger
      Credits spent in the last 30 days. Omitted for somebody who has not used the bot.
  • pageinteger
    This page.
  • pagesinteger
    Total pages (at least 1).
  • page_sizeinteger
    Always 25.
  • totalinteger
    People matching.
  • sortstring
    The order used.

Errors#

Besides the errors any request can get (authentication, rate limits):

StatusCodeWhen
404not_foundThe key is not minted for an app you own (a personal key, for example). Use a key from the app whose bot you manage.