select employee
Testing Env
https://testhr.vodoglobal.com
Testing Env
https://testhr.vodoglobal.com
GET
/api/v1/select-employee
Last modified:2025-03-26 12:40:51
API Request Description
Request Parameters
name (query parameter) - The name of the employee to be searched.Response
status (boolean) - Indicates the status of the response.message (string) - Provides any additional message related to the response.response (array) - Contains an array of objects with the following properties:id (number) - The ID of the employee.name (string) - The name of the employee.user_id (number) - The user ID associated with the employee.source (string or null) - The source of employee information.nationality_id (string) - The nationality ID of the employee.calendar_id (string or null) - The calendar ID associated with the employee.profile_url (string) - The URL to the employee's profile.Example Response
{
"status": true,
"message": "",
"response": [
{
"id": 0,
"name": "",
"user_id": 0,
"source": null,
"nationality_id": "",
"calendar_id": null,
"profile_url": ""
}
]
}
JSON Schema for Response
{
"type": "object",
"properties": {
"status": {"type": "boolean"},
"message": {"type": "string"},
"response": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {"type": "number"},
"name": {"type": "string"},
"user_id": {"type": "number"},
"source": {"type": ["string", "null"]},
"nationality_id": {"type": "string"},
"calendar_id": {"type": ["string", "null"]},
"profile_url": {"type": "string"}
}
}
}
}
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://testhr.vodoglobal.com/api/v1/select-employee?name=ma' \
--header 'secure-business-key: 4765066450c0bd66325.48403130' \
--header 'uuid: 630ca2f4885f8'Response Response Example
{
"status": true,
"message": "success",
"response": [
{
"id": 3331,
"name": "Marco",
"user_id": 926,
"source": null,
"nationality_id": "57",
"calendar_id": null,
"profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png"
},
{
"id": 3327,
"name": "Ammar Yasser",
"user_id": 921,
"source": null,
"nationality_id": "57",
"calendar_id": null,
"profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png"
},
{
"id": 3317,
"name": "Mariem",
"user_id": 854,
"source": null,
"nationality_id": "57",
"calendar_id": null,
"profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png"
},
{
"id": 3315,
"name": "Malak",
"user_id": 852,
"source": null,
"nationality_id": "57",
"calendar_id": null,
"profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png"
},
{
"id": 3312,
"name": "Mahmoud",
"user_id": 849,
"source": null,
"nationality_id": "57",
"calendar_id": null,
"profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png"
},
{
"id": 3277,
"name": "Mark Hopkins",
"user_id": 751,
"source": null,
"nationality_id": "57",
"calendar_id": 162,
"profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png"
}
]
}Request
Query Params
name
stringÂ
required
Example:
ma
Header Params
secure-business-key
stringÂ
required
Example:
{{secure_business_key}}
uuid
stringÂ
required
Example:
{{uuid}}