Skip to main content
The Users API provides endpoints to manage user profiles in the QeetMart platform. This service handles user information including names, email addresses, and phone numbers.

​
Base URL

http://localhost:8082

​
Authentication

Most endpoints require authentication via JWT tokens. Include your token in the Authorization header: 
Authorization: Bearer YOUR_JWT_TOKEN

​
Authorization

The Users API implements role-based access control:
  • Admin users can list all users and access any user profile
  • Regular users can only access and modify their own profile
  • User creation is available to authenticated users

​
Common response structure

All successful responses return data in a consistent format:
​
id
integer
The unique identifier for the user profile
​
userId
integer
The user ID from the authentication system
​
name
string
The user’s full name (max 120 characters)
​
email
string
The user’s email address (max 255 characters)
​
phone
string
The user’s phone number (7-20 characters)
​
createdAt
string
ISO 8601 timestamp when the profile was created
​
updatedAt
string
ISO 8601 timestamp when the profile was last updated

​
Error handling

The API returns standard HTTP status codes and structured error responses: 
{
  "timestamp": "2026-03-03T10:15:30Z",
  "status": 400,
  "error": "Bad Request",
  "message": "Validation failed",
  "path": "/users",
  "validationErrors": {
    "email": "email must be valid",
    "phone": "phone must be a valid number"
  }
}

​
Rate limiting

API requests are subject to rate limiting to ensure service stability. Rate limit headers are included in all responses:
  • X-RateLimit-Limit: Maximum requests allowed per time window
  • X-RateLimit-Remaining: Remaining requests in current window
  • X-RateLimit-Reset: Time when the rate limit resets

​
Next steps

View all endpoints

Explore detailed documentation for each Users API endpoint

Build docs developers (and LLMs) love

Get started for freeTalk to us