Skip to main content

Get Mapped Employees API

Overview

Retrieves all employees mapped to a specific Employee Band.

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

Request Body Schema

FieldTypeRequiredDescription
bandIdString (UUID)YesTarget Employee Band ID
searchStringNoSearch by name, email, or phone
pageNumberNoPagination page (Default: 1)
limitNumberNoItems per page (Default: 10)

Request Body Example

{
"bandId": "b1234567-89ab-cdef-0123-456789abcdef",
"search": "Rahul",
"page": 1,
"limit": 10
}

Success Response (200 OK)

{
"success": true,
"message": "Mapped employees retrieved for band 'Band 1'",
"data": [
{
"id": "u1111111-1111-1111-1111-111111111111",
"firstName": "Rahul",
"lastName": "Sharma",
"email": "rahul.sharma@company.com",
"phone": "+919876543210",
"bandId": "b1234567-89ab-cdef-0123-456789abcdef",
"employeeBand": "Band 1"
}
],
"pagination": {
"totalItems": 1,
"totalPages": 1,
"currentPage": 1,
"itemsPerPage": 10,
"hasNextPage": false,
"hasPreviousPage": false
}
}