Skip to main content

Get Current User Profile

curl -X GET https://api.example.com/users/me \
  -H "Authorization: Bearer YOUR_TOKEN"
{
  "message": "Get user successfully.",
  "user": {
    "uid": "user123",
    "email": "[email protected]",
    "username": "johndoe",
    "phone": "+1234567890",
    "rol": "user"
  }
}
Retrieve the authenticated user’s profile information. Endpoint: GET /users/me Authentication: Required (Bearer token)

Response

message
string
Success message
user
object
User profile data

Update Current User Profile

curl -X PUT https://api.example.com/users/me \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "username": "john_updated",
    "phone": "+1987654321",
    "email": "[email protected]"
  }'
{
  "message": "User updated successfully.",
  "user": {
    "uid": "user123",
    "email": "[email protected]",
    "username": "john_updated",
    "phone": "+1987654321",
    "rol": "user"
  }
}
Update the authenticated user’s profile information. Endpoint: PUT /users/me Authentication: Required (Bearer token)

Request Body

All fields are optional. Only include fields you want to update.
username
string
New username
phone
string
New phone number (must be valid phone format)
email
string
New email address (must be valid email format)

Response

message
string
Success message
user
object
Updated user profile data

Change Password

curl -X PUT https://api.example.com/users/me/password \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "password": "NewSecurePassword123!"
  }'
{
  "message": "User updated password successfully.",
  "user": {
    "uid": "user123",
    "email": "[email protected]",
    "username": "johndoe",
    "phone": "+1234567890",
    "rol": "user"
  }
}
Change the authenticated user’s password. Endpoint: PUT /users/me/password Authentication: Required (Bearer token)

Request Body

password
string
required
New password (must meet security requirements)

Response

message
string
Success message
user
object
User profile data

List All Users (Admin Only)

curl -X GET "https://api.example.com/users/?page_token=eyJpZCI6Im5leHQifQ==" \
  -H "Authorization: Bearer ADMIN_TOKEN"
{
  "message": "Get users successfully.",
  "users": [
    {
      "uid": "user123",
      "email": "[email protected]",
      "username": "user1",
      "phone": "+1234567890",
      "rol": "user"
    },
    {
      "uid": "user456",
      "email": "[email protected]",
      "username": "user2",
      "phone": "+9876543210",
      "rol": "user"
    }
  ]
}
Retrieve all users in the system (admin only). Endpoint: GET /users/ Authentication: Required (Bearer token with admin role)

Query Parameters

page_token
string
Pagination token for fetching next page

Response

message
string
Success message
users
array
Array of user objects

Build docs developers (and LLMs) love