v3/Employee API's

Create a New Employee

Overview

This API endpoint allows you to create a new employee in the system. You must provide at least the employee's name and email. Additional fields such as phone, user roles, site, and admin status can also be provided.

Endpoint Details

Method

POST

URL

https://api.mosler.in/api/v3/employee

Authentication

Headers

Name	Type	Required	Description
`apikey`	`string`	Yes	Your API key for authentication
`Content-Type`	`string`	Yes	`application/json`

Request Body

Name	Type	Required	Description
`name`	`string`	Yes	Name of the employee
`email`	`string`	Yes	Email address of the employee
`phone`	`string`	No	Phone number
`role`	`array`	No	Array of role strings (see values below)
`site_id`	`array`	Yes	Array of site ObjectIds the employee belongs to
`isAdmin`	`boolean`	No	Whether the employee has admin privileges

Valid values for role:

"user"
"regional manager"
"manager"
"front desk"
"house keeping"
"maintenance"

Request Example

{
    "name": "John Doe",
    "email": "john.doe@example.com",
    "phone": "+1234567890",
    "role": ["front desk"],
    "site_id": ["6530f9dce0c1bd73ded0d1be"],
    "isAdmin": false
}

Response Format

Success Response

Name	Type	Description
`success`	`boolean`	Always `true` for successful responses
`message`	`string`	Success message
`data`	`object`	Object containing created employee details

Success Example

{
    "success": true,
    "message": "Employee created successfully",
    "data": {
        "_id": "6530f9dce0c1bd73ded0d1aa",
        "name": "John Doe",
        "email": "john.doe@example.com",
        "phone": "+1234567890",
        "role": [{ "role": "front desk", "allowed": true }],
        "siteId": ["6530f9dce0c1bd73ded0d1be"],
        "isAdmin": false
    }
}

Error Response Example

{
    "success": false,
    "message": "Name and email are required fields"
}