POST/ add employee
Testing Env
https://testhr.vodoglobal.com
Testing Env
https://testhr.vodoglobal.com
POST
/api/v1/employees
Last modified:2025-03-26 12:40:51
Request
Response
{
"type": "object",
"properties": {
"status": {"type": "boolean"},
"message": {"type": "string"},
"response": {
"type": "object",
"properties": {
"business_id": {"type": "integer"},
"type": {"type": "string"},
"active": {"type": "integer"},
"source": {"type": "string"},
"social_situation": {"type": "string"},
"calendar_id": {"type": "integer"},
"phone": {"type": "string"},
"email": {"type": "string"},
"national_id": {"type": "string"},
"nationality_id": {"type": "integer"},
"occupation_id": {"type": "integer"},
"section_id": {"type": "integer"},
"company_id": {"type": "integer"},
"job_number": {"type": "string"},
"border_number": {"type": "string"},
"administration_id": {"type": "integer"},
"administration_admin": {"type": "integer"},
"trainer": {"type": "integer"},
"department_id": {"type": "integer"},
"emergency_name": {"type": "string"},
"emergency_phone": {"type": "string"},
"color": {"type": "string"},
"bio": {"type": ["null", "object"]},
"agent_ids": {"type": ["null", "array"]},
"employer": {"type": "string"},
"employer_company_id": {"type": "integer"},
"employer_branch_id": {"type": "integer"},
"employer_department_id": {"type": "integer"},
"employer_section_id": {"type": "integer"},
"updated_at": {"type": "string"},
"created_at": {"type": "string"},
"id": {"type": "integer"},
"user_id": {"type": "integer"},
"name": {"type": "string"},
"user_name": {"type": "string"},
"primary_email": {"type": "string"},
"profile_url": {"type": "string"}
}
}
}
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://testhr.vodoglobal.com/api/v1/employees' \
--header 'secure-business-key: 4765066450c0bd66325.48403130' \
--header 'user-token: ' \
--header 'uuid: 630ca2f4885f8' \
--header 'Content-Type: application/json' \
--data-raw '{
"name": "api doc",
"user_name": "api_doc",
"user_type": "employee",
"active": 1,
"source": "internal",
"social_situation": "single",
"calendar_id": 1,
"primary_email": "fagoxen3600@nastyx.com",
"phone": ["1234567890", "0987654321"],
"email": ["xohoco9231@nastyx.com"],
"national_id": "321547892254",
"nationality_id": 1,
"occupation_id": 66,
"section_id": 3,
"company_id": 4,
"job_number": "EMP123",
"border_number": "B123456",
"administration_id": 5,
"administration_admin": 34,
"trainer": 34,
"department_id": 6,
"emergency_name": "Jane Doe",
"emergency_phone": "1234567890",
"employer": "company",
"employer_company_id": 7,
"employer_branch_id": 3,
"employer_department_id": 8,
"employer_section_id": 9,
"passport_number": "P123456",
"release_date": "2024-01-01",
"expiry_date": "2034-01-01",
"side_version": "Version 1",
"function": "Function Name",
"address": "123 Main St",
"country_code": "US",
"date_of_birth": "1999-01-01",
"insurance_start_date": "2024-01-01",
"insurance_end_date": "2025-01-01",
"place_of_birth": "City",
"country_of_birth": "Country",
"city_id": 10,
"country_id": 11,
"id_issuance_date": "2020-01-01",
"id_expiration_date": "2030-01-01",
"bank_name": "Bank Name",
"account_name": "John Doe",
"account_number": "1234567890",
"iban_no": "IBAN123456",
"currency_id": 1,
"bank_address": "Bank Address",
"bank_country": "Country",
"source_company_id": 12,
"source_administration_id": 13,
"source_section_id": 14,
"building_no": "Building 1",
"residence": 1,
"branch_start_date": "2024-01-01",
"entering": "2024-01-01",
"expire_h": "2024-12-31",
"expire_m": "2024-12-31",
"work_permit_number": "WP123456",
"visa_number": "V123456",
"date_of_issuance_of_the_visa": "2024-01-01",
"visa_expiry_date": "2025-01-01",
"branch_id" : 2,
"color" : "#259874",
"skills": [
{
"skill_id": 1,
"level": 90
},
{
"skill_id": 2,
"level": 70
}
],
"schools": [
{
"school_name": "University A",
"start_date": "2018-09-01",
"end_date": "2022-06-30"
}
],
"experiences": [
{
"company_name": "Company X",
"occupation_id": 3,
"start_date": "2022-07-01",
"end_date": "2023-12-31"
}
],
"services_skill": [1, 2]
}'Response Response Example
{
"status": true,
"message": "success",
"response": {
"business_id": 259,
"type": "employee",
"active": 1,
"source": "internal",
"social_situation": "single",
"calendar_id": 1,
"phone": "[\"1234567890\",\"0987654321\"]",
"email": "[\"xohoco9231@nastyx.com\"]",
"national_id": "321547892254",
"nationality_id": 1,
"occupation_id": 66,
"section_id": 3,
"company_id": 4,
"job_number": "EMP123",
"border_number": "B123456",
"administration_id": 5,
"administration_admin": 34,
"trainer": 34,
"department_id": 6,
"emergency_name": "Jane Doe",
"emergency_phone": "1234567890",
"color": "#259874",
"bio": null,
"agent_ids": null,
"employer": "company",
"employer_company_id": 7,
"employer_branch_id": 3,
"employer_department_id": 8,
"employer_section_id": 9,
"updated_at": "2025-03-20T09:31:02.000000Z",
"created_at": "2025-03-20T09:30:58.000000Z",
"id": 3419,
"user_id": 1006,
"name": "api doc",
"user_name": "api_doc",
"primary_email": "fagoxen3600@nastyx.com",
"profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png"
}
}Request
Header Params
secure-business-key
stringÂ
required
Example:
{{secure_business_key}}
user-token
stringÂ
required
Example:
{{user_token}}
uuid
stringÂ
required
Example:
{{uuid}}
Body Params application/json