User Count Retrieval
Endpoint
POST /api/users/count
Parameters
| Name |
Type |
Required |
Description |
| query |
string |
No |
Search by username or phone |
| active |
string |
No |
Filter: all, true, false |
Response
{
"status": 200,
"result": {
"totalUsers": 150
}
}
User List Retrieval
Endpoint
POST /api/users
Parameters
| Name |
Type |
Required |
Description |
| page |
number |
Yes |
Current page number |
| limit |
number |
Yes |
Items per page |
| query |
string |
No |
Search by username or phone |
| active |
string |
No |
Filter: all, true, false |
Response
{
"status": 200,
"result": {
"users": [
{
"userId": 1001,
"username": "demo_user",
"mobile": "15512345678",
"joinDate": "2023-01-15T08:30:00Z",
"credits": 85.2,
"active": true,
"role": "user"
}
],
"totalItems": 150
}
}
Active User Count
Endpoint
GET /api/users/active/count
Response
{
"status": 200,
"result": {
"activeUsers": 42
}
}
Active User List
Endpoint
POST /api/users/active
Parameters
| Name |
Type |
Required |
Description |
| page |
number |
Yes |
Current page number |
| limit |
number |
Yes |
Items per page |
Response
{
"status": 200,
"result": {
"activeUsers": [
{
"userId": 2001,
"username": "active_user",
"lastLogin": "2023-11-20T14:25:00Z"
}
],
"totalActive": 42
}
}
User Creation
Endpoint
POST /api/users/create
Parameters
| Name |
Type |
Required |
Description |
| username |
string |
Yes |
User display name |
| mobile |
string |
Yes |
User phone number |
| role |
number |
Yes |
0=admin, 1=user, 2=organization |
| isActive |
number |
Yes |
1=active, 0=inactive |
Response
{
"status": 200,
"message": "User created",
"userId": 3001
}
User Update
Endpoint
PUT /api/users/update
Parameters
| Name |
Type |
Required |
Description |
| userId |
number |
Yes |
Target user ID |
| username |
string |
Yes |
New display name |
| mobile |
string |
Yes |
New phone number |
| role |
number |
Yes |
Updated role |
| isActive |
number |
Yes |
Updated status |
Response
{
"status": 200,
"message": "User updated"
}
User Deletion
Endpoint
DELETE /api/users/{userId}
Response
{
"status": 200,
"message": "User removed"
}
Status Codes
| Code |
Description |
| 200 |
Success |
| 400 |
Invalid parameters |
| 401 |
Unauthoriezd |
| 404 |
Resource not found |
| 500 |
Server error |
Implementation Examples
Fetch User Count
const response = await fetch('/api/users/count', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ query: 'demo', active: 'true' })
});
const data = await response.json();
Create New User
const newUser = await fetch('/api/users/create', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({
username: 'new_user',
mobile: '18812345678',
role: 1,
isActive: 1
})
});
Remove User
const deleteResponse = await fetch('/api/users/1001', {
method: 'DELETE'
});