---
title: "Get a bot user"
method: GET
path: "/telegram/users/{user}"
tags: ["Telegram bot users"]
---

# Get a bot user

`GET /telegram/users/{user}`

## Request

- Base URL: `https://api.vidmoat.com/v1`
- URL: `https://api.vidmoat.com/v1/telegram/users/{user}`
- Auth: HTTP bearer

One person, by numeric Telegram id or @username, with their standing, daily limit and usage. Works for somebody allowed before they ever messaged the bot.

## Path parameters

- `user` string, required

## Response `200`

Get a bot user

- object
  - `object` string: Always `telegram_user`.
  - `id` string, nullable: Vidmoat id of the person. `null` for somebody who has not used the bot yet.
  - `telegram_user_id` string, nullable: Numeric Telegram id, as a string.
  - `username` string, nullable: Telegram @username, without the @.
  - `display_name` string, nullable: Their Telegram name.
  - `status` 'active' | 'blocked': Whether they are blocked.
  - `allowlisted` boolean: On the bot's allowlist.
  - `daily_credits` integer, nullable: Their own daily credit limit. `null` means the bot's default.
  - `first_seen_at` string, nullable: ISO 8601 time of their first message.
  - `last_seen_at` string, nullable: ISO 8601 time of their latest message.
  - `projects` integer: Projects they have. Omitted for somebody who has not used the bot.
  - `messages_today` integer: Since midnight UTC. Omitted for somebody who has not used the bot.
  - `messages_30d` integer: Last 30 days. Omitted for somebody who has not used the bot.
  - `credits_today` integer: Credits spent since midnight UTC. Omitted for somebody who has not used the bot.
  - `credits_30d` integer: Credits spent in the last 30 days. Omitted for somebody who has not used the bot.

## Other responses

- `400`: `invalid_request`: `user` is neither a numeric id nor a valid username.
- `404`: `not_found`: The key is not minted for an app you own (a personal key, for example). Use a key from the app whose bot you manage.

---

[API](https://skmtc.dev/vidmoat/apis/vidmoat-api.md) · [All operations](https://skmtc.dev/vidmoat/apis/vidmoat-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vidmoat/apis/vidmoat-api/revisions/23e24e25c756?raw)