delete employee
Testing Env
https://testhr.vodoglobal.com
Testing Env
https://testhr.vodoglobal.com
DELETE
/api/v1/employees/3413
Last modified:2025-03-26 12:40:51
Delete Employee
Request
{{url}}api/v1/employees/3413
Response
{
"type": "object",
"properties": {
"status": {
"type": "boolean"
},
"message": {
"type": "string"
},
"response": {
"type": "object",
"properties": {
"id": {
"type": "integer"
},
"name": {
"type": "string"
},
"business_id": {
"type": "string"
},
"agent_ids": {
"type": ["array", "null"]
},
"type": {
"type": ["string", "null"]
},
"active": {
"type": "integer"
},
"social_situation": {
"type": ["string", "null"]
},
"user_type": {
"type": "string"
},
"primary_email": {
"type": "string"
},
"email_verified_at": {
"type": ["string", "null"]
},
"password": {
"type": ["string", "null"]
},
"remember_token": {
"type": ["string", "null"]
},
"email": {
"type": "string"
},
"phone": {
"type": "string"
},
"profile": {
"type": ["object", "null"]
},
"source": {
"type": ["string", "null"]
},
"national_id": {
"type": "string"
},
"nationality_id": {
"type": "string"
},
"occupation_id": {
"type": "integer"
},
"section_id": {
"type": ["integer", "null"]
},
"job_number": {
"type": ["string", "null"]
},
"company_id": {
"type": "integer"
},
"border_number": {
"type": ["string", "null"]
},
"deleted_at": {
"type": "string"
},
"created_at": {
"type": "string"
},
"updated_at": {
"type": "string"
},
"administration_id": {
"type": ["integer", "null"]
},
"department_id": {
"type": ["integer", "null"]
},
"calendar_id": {
"type": "integer"
},
"administration_admin": {
"type": ["string", "null"]
},
"trainer": {
"type": ["string", "null"]
},
"emergency_name": {
"type": ["string", "null"]
},
"emergency_phone": {
"type": "string"
},
"user_id": {
"type": "integer"
},
"user_name": {
"type": "string"
},
"employer": {
"type": "string"
},
"employer_company_id": {
"type": ["integer", "null"]
},
"employer_branch_id": {
"type": ["integer", "null"]
},
"employer_department_id": {
"type": ["integer", "null"]
},
"employer_section_id": {
"type": ["integer", "null"]
},
"client_id": {
"type": ["integer", "null"]
},
"color": {
"type": ["string", "null"]
},
"bio": {
"type": ["string", "null"]
},
"profile_url": {
"type": "string"
}
},
"required": ["id", "name", "business_id", "active", "user_type", "primary_email", "email", "phone", "national_id", "nationality_id", "occupation_id", "company_id", "deleted_at", "created_at", "updated_at", "calendar_id", "emergency_phone", "user_id", "user_name", "employer", "profile_url"]
}
},
"required": ["status", "message", "response"]
}
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request DELETE 'https://testhr.vodoglobal.com/api/v1/employees/3413' \
--header 'uuid: 630ca2f4885f8' \
--header 'secure_business_key: 4765066450c0bd66325.48403130' \
--header 'user_token: '
Response Response Example
{
"status": true,
"message": "success",
"response": {
"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": "2025-03-20T10:01:53.000000Z",
"created_at": "2025-03-13T13:01:48.000000Z",
"updated_at": "2025-03-20T10:01:53.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,
"profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png"
}
}
Request
Header Params
uuid
string
required
Example:
{{uuid}}
secure_business_key
string
required
Example:
{{secure_business_key}}
user_token
string
required
Example:
{{user_token}}