> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/Falasefemi2/companyflow/llms.txt
> Use this file to discover all available pages before exploring further.
# List Employees
> Get a paginated list of employees in a company with optional filtering
## Authentication
This endpoint requires Bearer token authentication with one of the following roles:
* `super_admin`
* `hr_manager`
## Path Parameters
The unique identifier of the company (UUID format)
## Query Parameters
Page number for pagination
Number of items per page
Filter by employee status (active, inactive, on\_leave, terminated, probation)
Filter by department UUID
Filter by manager UUID
Filter by employment type (full\_time, part\_time, contract, intern)
Search by name or email
## Response
Indicates if the request was successful
Array of employee objects
Employee UUID
Company UUID
Employee email address
Employee phone number
Employee first name
Employee last name
Internal employee code
Department UUID
Designation UUID
Level UUID
Role UUID
Manager UUID
Employee status
Employment type
Date of birth (ISO 8601 format)
Hire date (ISO 8601 format)
Termination date (ISO 8601 format)
Employee gender
Employee address
Emergency contact name
Emergency contact phone
Profile image URL
Last login timestamp (ISO 8601 format)
Creation timestamp (ISO 8601 format)
Last update timestamp (ISO 8601 format)
Current page number
Number of items per page
Total number of items
Total number of pages
```bash cURL theme={null}
curl -X GET "https://api.companyflow.com/companies/123e4567-e89b-12d3-a456-426614174000/employees?page=1&page_size=10&status=active&search=john" \
-H "Authorization: Bearer YOUR_TOKEN"
```
```bash With Filters theme={null}
curl -X GET "https://api.companyflow.com/companies/123e4567-e89b-12d3-a456-426614174000/employees?department_id=dept-uuid&employment_type=full_time" \
-H "Authorization: Bearer YOUR_TOKEN"
```
```json 200 Success theme={null}
{
"success": true,
"data": {
"employees": [
{
"id": "emp-uuid-1",
"company_id": "123e4567-e89b-12d3-a456-426614174000",
"email": "john.doe@example.com",
"phone": "+1234567890",
"first_name": "John",
"last_name": "Doe",
"employee_code": "EMP001",
"department_id": "dept-uuid-here",
"designation_id": "desig-uuid-here",
"level_id": "level-uuid-here",
"role_id": "role-uuid-here",
"manager_id": "manager-uuid-here",
"status": "active",
"employment_type": "full_time",
"date_of_birth": "1990-01-15T00:00:00Z",
"hire_date": "2024-01-01T00:00:00Z",
"termination_date": null,
"gender": "Male",
"address": "123 Main St, City, State",
"emergency_contact_name": "Jane Doe",
"emergency_contact_phone": "+1987654321",
"profile_image_url": "",
"last_login_at": "2024-03-01T15:30:00Z",
"created_at": "2024-01-01T10:00:00Z",
"updated_at": "2024-03-01T15:30:00Z"
}
],
"pagination": {
"page": 1,
"page_size": 10,
"total_items": 45,
"total_pages": 5
}
}
}
```
```json 400 Bad Request theme={null}
{
"success": false,
"message": "invalid department_id"
}
```
```json 401 Unauthorized theme={null}
{
"success": false,
"message": "insufficient role"
}
```