trashed employees

The API endpoint makes an HTTP GET request to retrieve trashed employee data based on various search parameters. The response is a JSON object with a status indicator, a message, and a response object containing paginated employee data. Each employee object includes various attributes such as id, name, business_id, type, active status, social_situation, user_type, primary_email, email_verified_at, password, remember_token, email, phone, profile, source, national_id, nationality_id, occupation_id, section_id, job_number, company_id, border_number, deleted_at, created_at, updated_at, administration_id, department_id, calendar_id, administration_admin, trainer, emergency_name, emergency_phone, user_id, user_name, employer details, client_id, color, bio, basicInfo, and profile_url.

{
  "type": "object",
  "properties": {
    "status": { "type": "boolean" },
    "message": { "type": "string" },
    "response": {
      "type": "object",
      "properties": {
        "current_page": { "type": "integer" },
        "data": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": { "type": "integer" },
              "name": { "type": ["string", "null"] },
              "business_id": { "type": "string" },
              "agent_ids": { "type": ["array", "null"] },
              "type": { "type": ["string", "null"] },
              "active": { "type": "integer" },
              "social_situation": { "type": "string" },
              "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", "null"] },
              "phone": { "type": "string" },
              "profile": { "type": ["string", "null"] },
              "source": { "type": ["string", "null"] },
              "national_id": { "type": "string" },
              "nationality_id": { "type": ["integer", "null"] },
              "occupation_id": { "type": "integer" },
              "section_id": { "type": ["integer", "null"] },
              "job_number": { "type": "string" },
              "company_id": { "type": "integer" },
              "border_number": { "type": "string" },
              "deleted_at": { "type": ["string", "null"] },
              "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": ["integer", "null"] },
              "trainer": { "type": ["integer", "null"] },
              "emergency_name": { "type": "string" },
              "emergency_phone": { "type": "string" },
              "user_id": { "type": "integer" },
              "user_name": { "type": ["string", "null"] },
              "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"] },
              "basicInfo": {
                "type": "object",
                "properties": {
                  "name": { "type": ["string", "null"] },
                  "user_name": { "type": ["string", "null"] },
                  "email": { "type": ["string", "null"] }
                }
              },
              "profile_url": { "type": "string" }
            }
          }
        },
        "first_page_url": { "type": ["string", "null"] },
        "from": { "type": "integer" },
        "last_page": { "type": "integer" },
        "last_page_url": { "type": ["string", "null"] },
        "links": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "url": { "type": ["string", "null"] },
              "label": { "type": "string" },
              "active": { "type": "boolean" }
            }
          }
        },
        "next_page_url": { "type": ["string", "null"] },
        "path": { "type": "string" },
        "per_page": { "type": "integer" },
        "prev_page_url": { "type": ["string", "null"] },
        "to": { "type": "integer" },
        "total": { "type": "integer" }
      }
    }
  }
}

curl --location --request GET 'https://testhr.vodoglobal.com/api/v1/trashed/employees' \ --header 'secure_business_key: 4765066450c0bd66325.48403130' \ --header 'uuid: 630ca2f4885f8' \ --header 'Accept: application/json' \ --header 'Content-Type: application/json' \ --data-raw '{}'

{ "status": true, "message": "success", "response": { "current_page": 1, "data": [ { "id": 3260, "name": null, "business_id": "259", "agent_ids": null, "type": "male", "active": 1, "social_situation": "widower", "user_type": "sub-user", "primary_email": "goraqoniru@mailinator.com", "email_verified_at": null, "password": null, "remember_token": null, "email": null, "phone": "[\"+1 (611) 156-3955\",\"+1 (565) 486-5541\",\"+1 (744) 734-3012\"]", "profile": "386", "source": null, "national_id": "Nesciunt mollit lab", "nationality_id": "99", "occupation_id": 47, "section_id": 19, "job_number": "166", "company_id": 259, "border_number": "616", "deleted_at": "2024-09-22T15:33:50.000000Z", "created_at": "2024-09-18T18:24:15.000000Z", "updated_at": "2024-09-22T15:33:50.000000Z", "administration_id": null, "department_id": 2, "calendar_id": 22, "administration_admin": 497, "trainer": 600, "emergency_name": "Cody Frank", "emergency_phone": "+1 (978) 671-4148", "user_id": 729, "user_name": null, "employer": "company", "employer_company_id": 259, "employer_branch_id": 2, "employer_department_id": 1, "employer_section_id": 18, "client_id": null, "color": null, "bio": null, "basicInfo": { "name": "Ifeoma Mcdowell", "user_name": "hefefyxi", "email": "goraqoniru@mailinator.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/386/emp_profile_3260_20240918062415.jpg" }, { "id": 3262, "name": null, "business_id": "259", "agent_ids": null, "type": "male", "active": 0, "social_situation": "widower", "user_type": "sub-user", "primary_email": null, "email_verified_at": null, "password": null, "remember_token": null, "email": "[\"vofuti@mailinator.com\",\"wixe@mailinator.com\",\"qocapen@mailinator.com\"]", "phone": "[\"+1 (196) 968-2643\",\"+1 (347) 657-1823\",\"+1 (866) 149-2245\"]", "profile": "393", "source": null, "national_id": "Ab animi voluptatem", "nationality_id": "99", "occupation_id": 47, "section_id": 18, "job_number": "553", "company_id": 259, "border_number": "688", "deleted_at": "2024-09-22T15:34:03.000000Z", "created_at": "2024-09-19T09:31:03.000000Z", "updated_at": "2024-09-22T15:34:03.000000Z", "administration_id": null, "department_id": 6, "calendar_id": 36, "administration_admin": 614, "trainer": 601, "emergency_name": "Alec Dickson", "emergency_phone": "+1 (668) 824-4597", "user_id": 731, "user_name": null, "employer": "company", "employer_company_id": 259, "employer_branch_id": 1, "employer_department_id": 7, "employer_section_id": 19, "client_id": null, "color": null, "bio": null, "basicInfo": { "name": null, "user_name": null, "email": null }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/393/emp_profile_3262_20240919093103.jpg" }, { "id": 3271, "name": "Mercedes Cote", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": "divorce", "user_type": "sub-user", "primary_email": "wezedip@mailinator.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "[\"zexarugo@mailinator.com\"]", "phone": "[\"+1 (143) 246-7056\"]", "profile": null, "source": null, "national_id": "Iste dolore irure de", "nationality_id": null, "occupation_id": 39, "section_id": null, "job_number": "524", "company_id": 259, "border_number": "254", "deleted_at": "2024-09-25T15:16:20.000000Z", "created_at": "2024-09-25T15:14:12.000000Z", "updated_at": "2024-09-25T15:16:20.000000Z", "administration_id": null, "department_id": null, "calendar_id": 22, "administration_admin": null, "trainer": null, "emergency_name": "Kasimir Schroeder", "emergency_phone": "+1 (459) 847-2512", "user_id": 739, "user_name": "wapepu", "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, "basicInfo": { "name": "Mercedes Cote", "user_name": "wapepu", "email": "wezedip@mailinator.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3272, "name": "Risa Clements", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": "widower", "user_type": "sub-user", "primary_email": "rinuzuwici@mailinator.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "[\"dawegodu@mailinator.com\"]", "phone": "[\"+1 (326) 792-4126\"]", "profile": null, "source": null, "national_id": "Dolor quis ex conseq", "nationality_id": null, "occupation_id": 47, "section_id": null, "job_number": "650", "company_id": 259, "border_number": "606", "deleted_at": "2024-09-25T15:16:14.000000Z", "created_at": "2024-09-25T15:14:40.000000Z", "updated_at": "2024-09-25T15:16:14.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": "Hannah Kirk", "emergency_phone": "+1 (308) 535-5919", "user_id": 740, "user_name": "kavacizu", "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, "basicInfo": { "name": "Risa Clements", "user_name": "kavacizu", "email": "rinuzuwici@mailinator.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3273, "name": "Quin Castillo", "business_id": "259", "agent_ids": null, "type": null, "active": 0, "social_situation": "divorce", "user_type": "sub-user", "primary_email": "golyvabaq@mailinator.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "[\"bomaxibat@mailinator.com\"]", "phone": "[\"+1 (476) 425-6911\"]", "profile": null, "source": null, "national_id": "999999", "nationality_id": "99", "occupation_id": 61, "section_id": null, "job_number": "645", "company_id": 259, "border_number": "907", "deleted_at": "2024-09-25T15:16:06.000000Z", "created_at": "2024-09-25T15:15:50.000000Z", "updated_at": "2024-09-25T15:16:06.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": 497, "trainer": 600, "emergency_name": "Cally Heath", "emergency_phone": "+1 (302) 538-6071", "user_id": 741, "user_name": "pucynevore", "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, "basicInfo": { "name": "Quin Castillo", "user_name": "pucynevore", "email": "golyvabaq@mailinator.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/user.png" }, { "id": 3333, "name": "sara ahmed", "business_id": "259", "agent_ids": null, "type": "female", "active": 1, "social_situation": "single", "user_type": "sub-user", "primary_email": "saraelkholssy216@gmail.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+201010707679\"]", "profile": "544", "source": null, "national_id": "898042", "nationality_id": "57", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": "2025-01-26T12:56:56.000000Z", "created_at": "2024-12-29T10:19:01.000000Z", "updated_at": "2025-01-26T12:56:56.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": null, "user_id": 929, "user_name": "sara", "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, "basicInfo": { "name": "sara ahmed", "user_name": "sara", "email": "saraelkholssy216@gmail.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/544/emp_profile_3333_2025-01-23-07:14:05.jpg" }, { "id": 3334, "name": "sara ahmed", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "57xuyucvc7@pduvb.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+201010707679\"]", "profile": "543", "source": null, "national_id": "514002", "nationality_id": "57", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": "2025-01-26T12:56:45.000000Z", "created_at": "2024-12-29T10:29:54.000000Z", "updated_at": "2025-01-26T12:56:45.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": null, "user_id": 930, "user_name": "c1ddgzl6dg", "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, "basicInfo": { "name": "sara ahmed", "user_name": "c1ddgzl6dg", "email": "57xuyucvc7@pduvb.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/543/emp_profile_3334_2025-01-23-07:11:51.jpg" }, { "id": 3335, "name": "sara ahmed", "business_id": "259", "agent_ids": null, "type": "female", "active": 1, "social_situation": "single", "user_type": "sub-user", "primary_email": "68ogz34wp0@ysuyl.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+201010707679\"]", "profile": "542", "source": null, "national_id": "519276", "nationality_id": "57", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": "2025-01-26T12:56:41.000000Z", "created_at": "2024-12-29T10:32:25.000000Z", "updated_at": "2025-01-26T12:56:41.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": null, "user_id": 931, "user_name": "9d6vlo08kk", "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, "basicInfo": { "name": "sara ahmed", "user_name": "9d6vlo08kk", "email": "68ogz34wp0@ysuyl.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/542/emp_profile_3335_2025-01-23-07:10:05.jpg" }, { "id": 3336, "name": "sara ahmed", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "vfkqdk0f4s@uunzd.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+201010707679\"]", "profile": "541", "source": null, "national_id": "852158", "nationality_id": "57", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": "2025-01-26T12:56:37.000000Z", "created_at": "2024-12-29T20:19:55.000000Z", "updated_at": "2025-01-26T12:56:37.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": null, "user_id": 932, "user_name": "vyurwjb1tz", "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, "basicInfo": { "name": "sara ahmed", "user_name": "vyurwjb1tz", "email": "vfkqdk0f4s@uunzd.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/541/emp_profile_3336_2025-01-23-07:09:12.jpg" }, { "id": 3337, "name": "sara ahmed", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "vv350j2vad@fbabb.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+201010707679\"]", "profile": "539", "source": null, "national_id": "290179", "nationality_id": "57", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": "2025-01-26T12:56:32.000000Z", "created_at": "2024-12-29T20:29:00.000000Z", "updated_at": "2025-01-26T12:56:32.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": null, "user_id": 933, "user_name": "0vq0k05trm", "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, "basicInfo": { "name": "sara ahmed", "user_name": "0vq0k05trm", "email": "test-p2i1d37ng@srv1.mail-tester.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/539/emp_profile_3337_2025-01-23-07:08:03.jpg" }, { "id": 3338, "name": "sara ahmed", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "eok9zaf4m1@waubo.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+201010707679\"]", "profile": "538", "source": null, "national_id": "216752", "nationality_id": "57", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": "2025-01-26T12:56:27.000000Z", "created_at": "2024-12-29T20:30:21.000000Z", "updated_at": "2025-01-26T12:56:27.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": null, "user_id": 934, "user_name": "fgm7sgm2cs", "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, "basicInfo": { "name": "sara ahmed", "user_name": "fgm7sgm2cs", "email": "eok9zaf4m1@waubo.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/538/emp_profile_3338_2025-01-23-07:06:36.jpg" }, { "id": 3339, "name": "sara ahmed", "business_id": "259", "agent_ids": null, "type": null, "active": 1, "social_situation": null, "user_type": "sub-user", "primary_email": "06z3zh03kb@tcryz.com", "email_verified_at": null, "password": null, "remember_token": null, "email": "null", "phone": "[\"+201010707679\"]", "profile": "537", "source": null, "national_id": "523958", "nationality_id": "57", "occupation_id": 81, "section_id": null, "job_number": null, "company_id": 259, "border_number": null, "deleted_at": "2025-01-26T12:56:23.000000Z", "created_at": "2024-12-29T20:32:43.000000Z", "updated_at": "2025-01-26T12:56:23.000000Z", "administration_id": null, "department_id": null, "calendar_id": null, "administration_admin": null, "trainer": null, "emergency_name": null, "emergency_phone": null, "user_id": 935, "user_name": "sn375dgcd5", "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, "basicInfo": { "name": "sara ahmed", "user_name": "sn375dgcd5", "email": "06z3zh03kb@tcryz.com" }, "profile_url": "https://testhr.vodoglobal.com/data/employee/profile/537/emp_profile_3339_2025-01-23-07:03:18.jpg" } ], "first_page_url": "https://testhr.vodoglobal.com/api/v1/trashed/employees?page=1", "from": 1, "last_page": 2, "last_page_url": "https://testhr.vodoglobal.com/api/v1/trashed/employees?page=2", "links": [ { "url": null, "label": "« Previous", "active": false }, { "url": "https://testhr.vodoglobal.com/api/v1/trashed/employees?page=1", "label": "1", "active": true }, { "url": "https://testhr.vodoglobal.com/api/v1/trashed/employees?page=2", "label": "2", "active": false }, { "url": "https://testhr.vodoglobal.com/api/v1/trashed/employees?page=2", "label": "Next »", "active": false } ], "next_page_url": "https://testhr.vodoglobal.com/api/v1/trashed/employees?page=2", "path": "https://testhr.vodoglobal.com/api/v1/trashed/employees", "per_page": 12, "prev_page_url": null, "to": 12, "total": 19 } }

Request

Query Params

string

optional

Example:

true

name

string

optional

Example:

mer

social_situation

string

optional

Example:

single

string

optional

Example:

test@gmail.com

type

string

optional

Example:

male

phone

string

optional

Example:

511111111

place_of_birth

string

optional

Example:

egypt

date_of_birth

string

optional

Example:

2025-03-18

company_id

string

optional

Example:

259

occupation_id

string

optional

Example:

country_of_birth

string

optional

Example:

2000-12-15

nationality_id

string

optional

Example:

contract_id

string

optional

Example:

Header Params

secure_business_key

string

required

Example:

uuid

string

required

Example:

string

required

Example:

application/json

Body Params application/json

object {0}

Examples

Responses

🟢200trashed employees

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