User Management API

Create, list, retrieve, update, and delete users within an organization.

Endpoints

Method	Path	Description
POST	/api/users/:orgId/create	Create a new user
GET	/api/users/:orgId/list	List all users
GET	/api/users/:orgId/overview	User count overview
GET	/api/users/:orgId/:userId	Get user by ID
PUT	/api/users/:orgId/:userId/update	Update a user
DELETE	/api/users/:orgId/:userId/delete	Delete a user

Path Parameters

Parameter	Type	Description
orgId	string	Organization ID
userId	string	User ID

---

Create User

POST /api/users/:orgId/create

Request Body

{
  "name": "Rahul Sharma",
  "email": "rahul.sharma@grandpalace.com",
  "phone": "+91-9012345678",
  "role": "665b2c3d4e5f6a7b8c9d0e1f",
  "designation": "Front Desk Manager",
  "isActive": true
}

Response — 201 Created

{
  "success": true,
  "message": "User created successfully",
  "data": {
    "_id": "665c3d4e5f6a7b8c9d0e1f2a",
    "name": "Rahul Sharma",
    "email": "rahul.sharma@grandpalace.com",
    "phone": "+91-9012345678",
    "role": {
      "_id": "665b2c3d4e5f6a7b8c9d0e1f",
      "name": "Front Desk"
    },
    "designation": "Front Desk Manager",
    "isActive": true,
    "orgId": "663f1a2b3c4d5e6f7a8b9c0d",
    "createdAt": "2026-02-23T10:30:00.000Z",
    "updatedAt": "2026-02-23T10:30:00.000Z"
  }
}

---

List Users

GET /api/users/:orgId/list

Response — 200 OK

{
  "success": true,
  "data": [
    {
      "_id": "665c3d4e5f6a7b8c9d0e1f2a",
      "name": "Rahul Sharma",
      "email": "rahul.sharma@grandpalace.com",
      "phone": "+91-9012345678",
      "role": {
        "_id": "665b2c3d4e5f6a7b8c9d0e1f",
        "name": "Front Desk"
      },
      "designation": "Front Desk Manager",
      "isActive": true,
      "createdAt": "2026-02-23T10:30:00.000Z"
    },
    {
      "_id": "665c3d4e5f6a7b8c9d0e1f2b",
      "name": "Priya Patel",
      "email": "priya.patel@grandpalace.com",
      "phone": "+91-9123456789",
      "role": {
        "_id": "665b2c3d4e5f6a7b8c9d0e20",
        "name": "Admin"
      },
      "designation": "General Manager",
      "isActive": true,
      "createdAt": "2026-02-22T09:00:00.000Z"
    }
  ]
}

---

User Overview

GET /api/users/:orgId/overview

Response — 200 OK

{
  "success": true,
  "data": {
    "totalUsers": 12,
    "activeUsers": 10,
    "inactiveUsers": 2
  }
}

---

Get User by ID

GET /api/users/:orgId/:userId

Response — 200 OK

{
  "success": true,
  "data": {
    "_id": "665c3d4e5f6a7b8c9d0e1f2a",
    "name": "Rahul Sharma",
    "email": "rahul.sharma@grandpalace.com",
    "phone": "+91-9012345678",
    "role": {
      "_id": "665b2c3d4e5f6a7b8c9d0e1f",
      "name": "Front Desk"
    },
    "designation": "Front Desk Manager",
    "isActive": true,
    "orgId": "663f1a2b3c4d5e6f7a8b9c0d",
    "createdAt": "2026-02-23T10:30:00.000Z",
    "updatedAt": "2026-02-23T10:30:00.000Z"
  }
}

---

Update User

PUT /api/users/:orgId/:userId/update

Request Body

{
  "name": "Rahul Sharma",
  "phone": "+91-9012345000",
  "designation": "Senior Front Desk Manager",
  "isActive": true
}

Response — 200 OK

{
  "success": true,
  "message": "User updated successfully",
  "data": {
    "_id": "665c3d4e5f6a7b8c9d0e1f2a",
    "name": "Rahul Sharma",
    "email": "rahul.sharma@grandpalace.com",
    "phone": "+91-9012345000",
    "role": {
      "_id": "665b2c3d4e5f6a7b8c9d0e1f",
      "name": "Front Desk"
    },
    "designation": "Senior Front Desk Manager",
    "isActive": true,
    "orgId": "663f1a2b3c4d5e6f7a8b9c0d",
    "createdAt": "2026-02-23T10:30:00.000Z",
    "updatedAt": "2026-02-23T12:00:00.000Z"
  }
}

---

Delete User

DELETE /api/users/:orgId/:userId/delete

Response — 200 OK

{
  "success": true,
  "message": "User deleted successfully"
}