Users Endpoints
Endpoints for managing user profiles and information.
Get User by ID
GET /user/{id}
Retrieve user information by ID.
Security: Bearer token authentication required
Parameters:
id
(path, required) - User ID
Responses:
200
- User found404
- User not found
Get User by Telegram ID
GET /user/telegram/{telegramId}
Retrieve user information by Telegram ID.
Security: Bearer token authentication required
Parameters:
telegramId
(path, required) - Telegram user ID
Responses:
200
- User found404
- User not found
Update User Profile
POST /user/{id}/profile
Update a user's profile information.
Security: Bearer token authentication required
Parameters:
id
(path, required) - User ID
Request Body:
{
"username": "john_doe",
"firstname": "John",
"lastname": "Doe",
"avatar": "https://example.com/avatar.jpg",
"signature": "Crypto enthusiast"
}
Response: 200 OK with updated user entity
Profile Fields
Field | Type | Description | Max Length |
---|---|---|---|
username | string | Username for the user | 50 |
firstname | string | User's first name | 50 |
lastname | string | User's last name | 50 |
avatar | string | URL to user's avatar image | - |
signature | string | User signature or bio | 200 |
Update Telegram Information
POST /user/{id}/telegram
Update a user's Telegram information.
Security: Bearer token authentication required
Parameters:
id
(path, required) - User ID
Request Body:
{
"telegramId": "123456789",
"telegramUsername": "@johndoe",
"telegramFirstName": "John",
"telegramLastName": "Doe",
"telegramAvatarUrl": "https://t.me/i/userpic/123.jpg",
"telegramAuthDate": "2024-01-25T12:00:00Z",
"telegramVerified": true
}
Response: 200 OK with updated user entity
Telegram Fields
Field | Type | Description | Required | Max Length |
---|---|---|---|---|
telegramId | string | Telegram user ID | Yes | - |
telegramUsername | string | Telegram username | No | 50 |
telegramFirstName | string | First name from Telegram profile | No | 50 |
telegramLastName | string | Last name from Telegram profile | No | 50 |
telegramAvatarUrl | string | URL to Telegram profile picture | No | - |
telegramAuthDate | date-time | Date when Telegram auth occurred | No | - |
telegramVerified | boolean | Whether Telegram account is verified | No | - |