Skip to main content

Get Employee

Retrieve the profile of a single employee by their BizzAssure employee ID.

Endpoint

GET /v1/client/employees/profile

Request

Headers

HeaderValue
AuthorizationBearer YOUR_ACCESS_TOKEN

Query Parameters

ParameterTypeRequiredDescription
employee_idstringYesBizzAssure internal employee ID returned when the employee was created

Example Request

GET /v1/client/employees/profile?employee_id=ba_emp_01jwz3k
Authorization: Bearer YOUR_ACCESS_TOKEN

Response

Success (200 OK)

{
"payload": {
"employee": {
"id": "ba_emp_01jwz3k...",
"user_id": "ba_user_xyz...",
"client_id": "ba_client_abc...",
"employee_id": "EMP001",
"name": "Ravi Kumar",
"email": "ravi.kumar@company.com",
"phone_number": "9876543210",
"date_of_birth": "1990-04-15",
"gender": "MALE",
"designation": "Software Engineer",
"department": "Engineering",
"date_of_joining": "2022-01-10",
"date_of_leaving": "",
"address": "123 MG Road, Bengaluru, Karnataka 560001",
"personal_email": "ravi@personal.com",
"personal_phone_number": "9123456789",
"is_admin": false,
"status": "ACTIVE"
},
"message": "Employee retrieved successfully",
"success": true
}
}

Employee Object Fields

FieldTypeDescription
idstringBizzAssure internal employee record ID
user_idstringAssociated BizzAssure user account ID
client_idstringClient/organisation ID this employee belongs to
employee_idstringYour original internal employee identifier
namestringFull name
emailstringOfficial email address
phone_numberstringOfficial phone number
date_of_birthstringDate of birth (YYYY-MM-DD)
genderstringMALE, GENDER_FEMALE, or GENDER_OTHER
designationstringJob title
departmentstringDepartment
date_of_joiningstringDate of joining (YYYY-MM-DD)
date_of_leavingstringDate of leaving (YYYY-MM-DD), empty if still active
addressstringResidential address
personal_emailstringPersonal email address
personal_phone_numberstringPersonal phone number
is_adminbooleanWhether the employee has employer-level admin access
statusstringACTIVE, INACTIVE, or INACTIVE_ONGOING_CLAIM

Error Responses

Not Found (404)

{
"type": "NOT_FOUND",
"title": "Employee Not Found",
"detail": "No employee found with the given employee_id for this client",
"instance": "/v1/client/employees/profile"
}

Missing Parameter (400 Bad Request)

{
"type": "MISSING_EMPLOYEE_ID",
"title": "Employee ID is required",
"detail": "Employee ID must be provided in URL parameters",
"instance": "/v1/client/employees/profile"
}