Skip to main content

Get Unmapped Employees API

Overview

Retrieves employees under a company who are unmapped to an Employee Band (or not mapped to the specified Band ID).

  • Endpoint: /api/bands/get-unmapped-employees
  • Method: POST
  • Access: Company Admin / Super Admin

Request Body Schema

FieldTypeRequiredDescription
companyIdString (UUID)YesTarget Company ID
bandIdString (UUID)NoBand ID to filter unmapped employees against
searchStringNoSearch by name, email, or phone
pageNumberNoPagination page (Default: 1)
limitNumberNoItems per page (Default: 10)

Request Body Example

{
"companyId": "c478a846-993d-4c8d-bf8d-d77cb3370e01",
"bandId": "b1234567-89ab-cdef-0123-456789abcdef",
"search": "",
"page": 1,
"limit": 10
}

Success Response (200 OK)

{
"success": true,
"message": "Unmapped employees retrieved successfully",
"data": [
{
"id": "u9999999-9999-9999-9999-999999999999",
"firstName": "Priya",
"lastName": "Mehta",
"email": "priya.mehta@company.com",
"phone": "+919876543219",
"bandId": null,
"employeeBand": null
}
],
"pagination": {
"totalItems": 1,
"totalPages": 1,
"currentPage": 1,
"itemsPerPage": 10,
"hasNextPage": false,
"hasPreviousPage": false
}
}