employees

Get Employees

This endpoint allows you to retrieve a list of employees based on specified search criteria.

Request Body

search (boolean): Indicates whether a search is being performed.

social_situation (string): The social situation of the employee.

email (string): The email address of the employee.

name (string): The name of the employee.

type (string): The type of the employee.

phone (string): The phone number of the employee.

place_of_birth (string): The place of birth of the employee.

date_of_birth (string): The date of birth of the employee.

company_id (integer): The ID of the company the employee belongs to.

occupation_id (integer): The ID of the occupation of the employee.

country_of_birth (string): The country of birth of the employee.

nationality_id (integer): The nationality ID of the employee.

contract_id (integer): The ID of the contract of the employee.

Response

The response will be a JSON object with the following schema:

{
  "status": true,
  "message": "",
  "response": {
    "current_page": 0,
    "data": [
      {
        "id": 0,
        "name": "",
        "business_id": "",
        "agent_ids": null,
        "type": "",
        "active": 0,
        "social_situation": "",
        "user_type": "",
        "primary_email": "",
        "email_verified_at": null,
        "password": null,
        "remember_token": null,
        "email": "",
        "phone": "",
        "profile": null,
        "source": "",
        "national_id": "",
        "nationality_id": "",
        "occupation_id": 0,
        "section_id": 0,
        "job_number": "",
        "company_id": 0,
        "border_number": "",
        "deleted_at": null,
        "created_at": "",
        "updated_at": "",
        "administration_id": 0,
        "department_id": 0,
        "calendar_id": 0,
        "administration_admin": 0,
        "trainer": 0,
        "emergency_name": "",
        "emergency_phone": "",
        "user_id": 0,
        "user_name": "",
        "employer": "",
        "employer_company_id": 0,
        "employer_branch_id": 0,
        "employer_department_id": 0,
        "employer_section_id": 0,
        "client_id": null,
        "color": "",
        "bio": null,
        "current_contract_id": null,
        "profile_url": ""
      }
    ],
    "first_page_url": "",
    "from": 0,
    "last_page": 0,
    "last_page_url": "",
    "links": [
      {
        "url": null,
        "label": "",
        "active": true
      }
    ],
    "next_page_url": "",
    "path": "",
    "per_page": 0,
    "prev_page_url": null,
    "to": 0,
    "total": 0
  }
}

curl --location --request POST 'https://testhr.vodoglobal.com/api/v1/get-employees' \ --header 'uuid: 630ca2f4885f8' \ --header 'secure-business-key: 4765066450c0bd66325.48403130' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{ "search" : false, // true or false "social_situation": "single", "email" : "royara6658@marchub.com", "name" : "jo", "type" : "female", "phone" : "32323", "place_of_birth" : "مصر", "date_of_birth" : "1992-04-23", "company_id": 50, "occupation_id" : 234, "country_of_birth" : "egypt", "nationality_id" : 256, "contract_id" : 23 }'

{ "status": true, "message": "Employees retrieved successfully.", "response": { "current_page": 1, "data": [ { "id": 3419, "name": "api doc", "business_id": "259", "agent_ids": null, "type": "employee", "active": 1, "social_situation": "single", "user_type": "sub-user", "primary_email": "fagoxen3600@nastyx.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "[\"xohoco9231@nastyx.com\"]", "phone": "[\"1234567890\",\"0987654321\"]", "profile": null, "source": "internal", "national_id": "321547892254", "nationality_id": "1", "occupation_id": 66, "section_id": 3, "job_number": "EMP123", "company_id": 4, "border_number": "B123456", "deleted_at": null, "created_at": "2025-03-20T09:30:58.000000Z", "updated_at": "2025-03-20T09:31:02.000000Z", "administration_id": 5, "department_id": 6, "calendar_id": 1, "administration_admin": 34, "trainer": 34, "emergency_name": "Jane Doe", "emergency_phone": "1234567890", "user_id": 1006, "user_name": "api_doc", "employer": "company", "employer_company_id": 7, "employer_branch_id": 3, "employer_department_id": 8, "employer_section_id": 9, "client_id": null, "color": "#259874", "bio": null, "current_contract_id": null, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3415, "name": "final final", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "sss@gmail.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+966511111111111\"]", "profile": null, "source": null, "national_id": "scadsczx", "nationality_id": "57", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": null, "created_at": "2025-03-13T13:05:44.000000Z", "updated_at": "2025-03-13T13:37:56.000000Z", "administration_id": null, "department_id": null, "calendar_id": 354, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": "+966", "user_id": 1004, "user_name": "Hamza", "employer": "not working", "employer_company_id": null, "employer_branch_id": null, "employer_department_id": null, "employer_section_id": null, "client_id": null, "color": "#e52424", "bio": null, "current_contract_id": null, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3413, "name": "فاينال", "business_id": "259", "agent_ids": null, "type": null, "active": 0, "social_situation": null, "user_type": "sub-user", "primary_email": "ss@gmail.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+966511111111111\"]", "profile": null, "source": null, "national_id": "scsd", "nationality_id": "57", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": null, "created_at": "2025-03-13T13:01:48.000000Z", "updated_at": "2025-03-13T13:43:43.000000Z", "administration_id": null, "department_id": null, "calendar_id": 354, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": "+966", "user_id": 1003, "user_name": "Marwan", "employer": "not working", "employer_company_id": null, "employer_branch_id": null, "employer_department_id": null, "employer_section_id": null, "client_id": null, "color": null, "bio": null, "current_contract_id": null, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3397, "name": "ibrahim", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "radasej125@codverts.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+96612312345\"]", "profile": null, "source": null, "national_id": "12312312450456", "nationality_id": "57", "occupation_id": 47, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": null, "created_at": "2025-02-24T08:16:53.000000Z", "updated_at": "2025-02-24T08:20:23.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": "+966", "user_id": 981, "user_name": "ibrahim", "employer": "not working", "employer_company_id": null, "employer_branch_id": null, "employer_department_id": null, "employer_section_id": null, "client_id": null, "color": null, "bio": null, "current_contract_id": null, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3391, "name": "khaled", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "khaled@gmail.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+9661112233344\"]", "profile": null, "source": null, "national_id": "1231241215123", "nationality_id": "57", "occupation_id": 47, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": null, "created_at": "2025-02-18T09:13:20.000000Z", "updated_at": "2025-02-18T09:13:21.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": "+966", "user_id": 974, "user_name": "khaled234", "employer": "not working", "employer_company_id": null, "employer_branch_id": null, "employer_department_id": null, "employer_section_id": null, "client_id": null, "color": null, "bio": null, "current_contract_id": null, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3382, "name": "ali", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": "single", "user_type": "sub-user", "primary_email": "test@test.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "[\"ali2@gmail.com\",\"ali3@gmail.com\"]", "phone": "[\"+96612345678\",\"+96687654321\"]", "profile": null, "source": null, "national_id": "12345678964", "nationality_id": "57", "occupation_id": 57, "section_id": 36, "job_number": "20", "company_id": 259, "border_number": "30", "deleted_at": null, "created_at": "2025-02-16T12:21:32.000000Z", "updated_at": "2025-02-17T16:33:56.000000Z", "administration_id": 112, "department_id": null, "calendar_id": null, "administration_admin": 780, "trainer": 730, "emergency_name": "140", "emergency_phone": "+966150160170", "user_id": 441, "user_name": "ali", "employer": "not working", "employer_company_id": null, "employer_branch_id": null, "employer_department_id": null, "employer_section_id": null, "client_id": null, "color": null, "bio": "test bio", "current_contract_id": null, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3381, "name": "testEmp", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "12312412231234@asd.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+966123124\"]", "profile": null, "source": null, "national_id": "asdaf1231", "nationality_id": "57", "occupation_id": 47, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": null, "created_at": "2025-02-16T11:08:54.000000Z", "updated_at": "2025-02-16T11:08:54.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": "+966", "user_id": 440, "user_name": "testEmp", "employer": "not working", "employer_company_id": null, "employer_branch_id": null, "employer_department_id": null, "employer_section_id": null, "client_id": null, "color": null, "bio": null, "current_contract_id": null, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3380, "name": "testbio4", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "testbio4@gmail.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+966123155123\"]", "profile": null, "source": null, "national_id": "q1231241254", "nationality_id": "2", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": null, "created_at": "2025-02-13T13:34:09.000000Z", "updated_at": "2025-02-13T13:34:09.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": "+966", "user_id": 437, "user_name": "testbio4", "employer": "not working", "employer_company_id": null, "employer_branch_id": null, "employer_department_id": null, "employer_section_id": null, "client_id": null, "color": null, "bio": null, "current_contract_id": null, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3379, "name": "test_bio3", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "test_bio3@gmail.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+9661231245\"]", "profile": null, "source": null, "national_id": "12315155131", "nationality_id": "57", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": null, "created_at": "2025-02-13T11:59:23.000000Z", "updated_at": "2025-02-13T11:59:24.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": "+966", "user_id": 435, "user_name": "test_bio3", "employer": "not working", "employer_company_id": null, "employer_branch_id": null, "employer_department_id": null, "employer_section_id": null, "client_id": null, "color": null, "bio": "tesat bio", "current_contract_id": null, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3372, "name": "test326788", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "test23444@test.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+9664564241\"]", "profile": null, "source": null, "national_id": "412452020440", "nationality_id": "57", "occupation_id": 47, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": null, "created_at": "2025-02-05T11:49:38.000000Z", "updated_at": "2025-02-05T11:49:39.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": "+966", "user_id": 951, "user_name": "test326788", "employer": "not working", "employer_company_id": null, "employer_branch_id": null, "employer_department_id": null, "employer_section_id": null, "client_id": null, "color": null, "bio": null, "current_contract_id": null, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" } ], "first_page_url": "https://testhr.vodoglobal.com/api/v1/get-employees?page=1", "from": 1, "last_page": 5, "last_page_url": "https://testhr.vodoglobal.com/api/v1/get-employees?page=5", "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "https://testhr.vodoglobal.com/api/v1/get-employees?page=1", "label": "1", "active": true }, { "url": "https://testhr.vodoglobal.com/api/v1/get-employees?page=2", "label": "2", "active": false }, { "url": "https://testhr.vodoglobal.com/api/v1/get-employees?page=3", "label": "3", "active": false }, { "url": "https://testhr.vodoglobal.com/api/v1/get-employees?page=4", "label": "4", "active": false }, { "url": "https://testhr.vodoglobal.com/api/v1/get-employees?page=5", "label": "5", "active": false }, { "url": "https://testhr.vodoglobal.com/api/v1/get-employees?page=2", "label": "Next »", "active": false } ], "next_page_url": "https://testhr.vodoglobal.com/api/v1/get-employees?page=2", "path": "https://testhr.vodoglobal.com/api/v1/get-employees", "per_page": 10, "prev_page_url": null, "to": 10, "total": 46 } }

Request

Query Params

per_page

string

optional

Example:

page

string

optional

Example:

Header Params

uuid

string

required

Example:

secure-business-key

string

required

Example:

string

required

Example:

application/json

Body Params application/json

boolean

required

social_situation

string

required

string

required

name

string

required

type

string

required

phone

string

required

place_of_birth

string

required

date_of_birth

string

required

company_id

integer

required

occupation_id

integer

required

country_of_birth

string

required

nationality_id

integer

required

contract_id

integer

required

Examples

Responses

🟢200employees

application/json

Body

status

boolean

required

message

string

required

response

object

required

current_page

integer

required

data

array [object {45}]

required

first_page_url

string

required

from

integer

required

last_page

integer

required

last_page_url

string

required

links

array [object {3}]

required

next_page_url

string

required

path

string

required

per_page

integer

required

prev_page_url

null

required

integer

required

total

integer

required

Get Employees#

Request Body#

Response#

Request

Responses

Get Employees

Request Body

Response