Skip to main content

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 found
  • 404 - 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 found
  • 404 - 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

FieldTypeDescriptionMax Length
usernamestringUsername for the user50
firstnamestringUser's first name50
lastnamestringUser's last name50
avatarstringURL to user's avatar image-
signaturestringUser signature or bio200

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

FieldTypeDescriptionRequiredMax Length
telegramIdstringTelegram user IDYes-
telegramUsernamestringTelegram usernameNo50
telegramFirstNamestringFirst name from Telegram profileNo50
telegramLastNamestringLast name from Telegram profileNo50
telegramAvatarUrlstringURL to Telegram profile pictureNo-
telegramAuthDatedate-timeDate when Telegram auth occurredNo-
telegramVerifiedbooleanWhether Telegram account is verifiedNo-