Skip to main content

Retrieve Employee by ID

Overview​

Retrieves a single employee record by its unique ID. Returns the full employee details including contact information and referral code.

Command Details​

  • Command: RetrieveEmployeeByIdQuery
  • Type: Query (read operation)

API Endpoint​

POST /api/bpm/cmd

Request Structure​

FieldTypeRequiredDescription
$typestringYesMust be RetrieveEmployeeByIdQuery
idlongYesThe employee record ID

Try It Out​

POST/api/bpm/cmdRetrieveEmployeeByIdQuery
Request Body

Response Structure​

Success:

{
"success": true,
"data": {
"id": 101,
"staffId": "EMP-001234",
"email": "john.doe@company.com",
"firstName": "John",
"lastName": "Doe",
"middleName": "Adewale",
"title": "Mr",
"dateOfBirth": "1990-05-15",
"branch": "Lagos Main Branch",
"branchName": "Lagos Main Branch",
"role": "Relationship Manager",
"roleName": "Relationship Manager",
"isAccountOfficer": false,
"canReferCustomer": true,
"referralCode": "REF-EMP001234",
"note": "Senior staff member",
"contactDetails": {
"mobile": "08012345678",
"addressLine1": "15 Marina Street",
"city": "Lagos",
"state": "Lagos",
"country": "Nigeria"
},
"status": 1,
"createdAt": "2026-03-09T10:30:00Z",
"updatedAt": "2026-03-09T14:00:00Z"
},
"message": "Employee retrieved successfully"
}

Error:

{
"success": false,
"data": null,
"message": "Employee not found",
"errors": [
"No employee found with the specified ID"
]
}