This endpoint retrieves all users with pagination.
- Method:
GET
- Response:
200 OK
: A list of users with a total count.- Query Parameters:
pagination
: Defines pagination settings (page and limit).
"pagination": { "page": 1, "limit": 10 }
- Response Body:
{ "users": [ { "id": 1, "name": "John Doe", "email": "[email protected]", "status": 1, "createdAt": "2024-12-01T10:00:00.sssZ", "lastUpdate": "2025-01-01T08:30:15.sssZ" } ... ], "count": 10 }
This endpoint retrieves detailed information about a specific user by ID.
- Method:
GET
- Path Parameter:
id
: The unique ID of the user.
- Response:
200 OK
: The user information.- Response Body:
{ "user": { "id": 1, "name": "John Doe", "email": "[email protected]", "status": 1, "createdAt": "2024-12-01T10:00:00.sssZ", "lastUpdate": "2025-01-01T08:30:15.sssZ" } }
This endpoint retrieves information about the currently authenticated user.
- Method:
GET
- Response:
200 OK
: The current authenticated user's information.- Response Body:
{ "user": { "id": 1, "name": "John Doe", "email": "[email protected]", "status": 1, "createdAt": "2024-12-01T10:00:00.sssZ", "lastUpdate": "2025-01-01T08:30:15.sssZ" } }
This endpoint creates a new user.
- Method:
POST
- Request Body:
{ "name": "Jane Doe", "email": "[email protected]", "password": "Password123!" }
- Response:
201 Created
: The newly created user.- Response Body:
{ "user": { "id": 2, "name": "Jane Doe", "email": "[email protected]", "status": 1, "createdAt": "2024-12-01T10:00:00.sssZ", "lastUpdate": "2024-12-01T10:00:00.sssZ" } }
This endpoint updates a specific user's details by ID.
- Method:
PUT
- Path Parameter:
id
: The unique ID of the user to update.
- Request Body:
{ "name": "John Doe Updated", "email": "[email protected]" }
- Response:
204 No Content
: Successfully updated the user.- Response Body: Empty.
This endpoint updates the currently authenticated user's own details.
- Method:
PUT
- Request Body:
{ "name": "John Doe Updated" }
- Response:
204 No Content
: Successfully updated the current user's details.- Response Body: Empty.
This endpoint deletes a specific user by ID.
- Method:
DELETE
- Path Parameter:
id
: The unique ID of the user to delete.
- Response:
204 No Content
: Successfully deleted the user.- Response Body: Empty.