Skip to main content
GET
/
companies
/
{company_id}
/
employees
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"

{
  "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
    }
  }
}

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.

​
Authentication

This endpoint requires Bearer token authentication with one of the following roles:
  • super_admin
  • hr_manager

​
Path Parameters

​
company_id
string
required
The unique identifier of the company (UUID format)

​
Query Parameters

​
page
integer
default:"1"
Page number for pagination
​
page_size
integer
default:"10"
Number of items per page
​
status
string
Filter by employee status (active, inactive, on_leave, terminated, probation)
​
department_id
string
Filter by department UUID
​
manager_id
string
Filter by manager UUID
​
employment_type
string
Filter by employment type (full_time, part_time, contract, intern)
​
search
string
Search by name or email

​
Response

​
success
boolean
Indicates if the request was successful
​
data
object
​
employees
array
Array of employee objects
​
id
string
Employee UUID
​
company_id
string
Company UUID
​
email
string
Employee email address
​
phone
string
Employee phone number
​
first_name
string
Employee first name
​
last_name
string
Employee last name
​
employee_code
string
Internal employee code
​
department_id
string
Department UUID
​
designation_id
string
Designation UUID
​
level_id
string
Level UUID
​
role_id
string
Role UUID
​
manager_id
string
Manager UUID
​
status
string
Employee status
​
employment_type
string
Employment type
​
date_of_birth
string
Date of birth (ISO 8601 format)
​
hire_date
string
Hire date (ISO 8601 format)
​
termination_date
string
Termination date (ISO 8601 format)
​
gender
string
Employee gender
​
address
string
Employee address
​
emergency_contact_name
string
Emergency contact name
​
emergency_contact_phone
string
Emergency contact phone
​
profile_image_url
string
Profile image URL
​
last_login_at
string
Last login timestamp (ISO 8601 format)
​
created_at
string
Creation timestamp (ISO 8601 format)
​
updated_at
string
Last update timestamp (ISO 8601 format)
​
pagination
object
​
page
integer
Current page number
​
page_size
integer
Number of items per page
​
total_items
integer
Total number of items
​
total_pages
integer
Total number of pages
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"

{
  "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
    }
  }
}

Build docs developers (and LLMs) love

Get started for freeTalk to us