GET/ administration

This endpoint retrieves administration data based on the provided query parameters. The "keyword" parameter is used to filter the administrations, while "company_id" and "admin_id" are used for specific company and admin identification.

The response will be in JSON format with a "status" indicating the success, a "message" field for any additional information, and a "response" object containing the administration details, including ID, image, name, company details, calendar details, activity status, type, activation and deactivation dates, geographical coordinates, and a list of employees associated with the administration.

For example, a successful response will include an array of administrations and pagination details, while an unsuccessful response will include an error message.

This endpoint retrieves administration details based on the provided keyword, company ID, and admin ID.

Request Parameters

keyword (query parameter) - The keyword to search for.

company_id (query parameter) - The ID of the company.

admin_id (query parameter) - The ID of the admin.

Response

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

{
    "status": true,
    "message": "",
    "response": {
        "administration": {
            "id": 0,
            "image": "",
            "name": "",
            "company_id": "",
            "company_name": "",
            "calendar_id": "",
            "calendar_name": "",
            "active": "",
            "type": "",
            "activation_date": "",
            "deactivation_date": "",
            "latitude": "",
            "longitude": "",
            "employees": []
        }
    }
}

In some cases, the response may include pagination information:

{
    "status": true,
    "message": "",
    "response": {
        "administrations": [
            {
                "id": 0,
                "image": "",
                "name": "",
                "company_id": "",
                "company_name": "",
                "calendar_id": "",
                "calendar_name": "",
                "active": "",
                "type": "",
                "activation_date": "",
                "deactivation_date": "",
                "latitude": "",
                "longitude": "",
                "employees": []
            }
        ],
        "pagination": {
            "total": 0,
            "per_page": 0,
            "current_page": 0,
            "last_page": 0,
            "from": 0,
            "to": 0
        }
    }
}

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

{ "status": true, "message": "success", "response": { "administrations": [ { "id": 126, "image": "https://testhr.vodoglobal.com/data/employee/profile/user.png", "name": "test audits", "company_id": "259", "company_name": "تجريبى فودو", "calendar_id": "371", "calendar_name": "test admin 3", "active": "yes", "type": "main", "activation_date": "2025-03-22", "deactivation_date": "2025-04-30", "latitude": "24.63016565", "longitude": "46.71697021", "employees": [] }, { "id": 125, "image": "https://testhr.vodoglobal.com/data/employee/profile/602/admin_profile_125_2025-03-17-04:00:17.jpg", "name": "test department2", "company_id": "259", "company_name": "تجريبى فودو", "calendar_id": "371,521", "calendar_name": "test admin 3", "active": "yes", "type": "main", "activation_date": "2025-03-17", "deactivation_date": "2025-03-18", "latitude": null, "longitude": null, "employees": [] }, { "id": 124, "image": "https://testhr.vodoglobal.com/data/employee/profile/603/admin_profile_124_2025-03-19-01:09:19.jpg", "name": "test department1", "company_id": "259", "company_name": "تجريبى فودو", "calendar_id": null, "calendar_name": null, "active": "yes", "type": "main", "activation_date": "2025-03-17", "deactivation_date": "2025-03-18", "latitude": "29.96385798", "longitude": "31.06778305", "employees": [ { "id": 3299, "user_id": 780, "image": "https://testhr.vodoglobal.com/data/employee/profile/489/emp_profile_3299_2024-12-15-02:07:10.jpg", "name": "Mostafa Hassan", "user_name": "cojeweraq", "phone": "[\"+201111111112\",\"+202222222221\"]", "email": "morigi9316@kindomd.com", "active": 1, "currency_id": null, "company_id": 259, "occupation_id": 47 }, { "id": 3312, "user_id": 849, "image": "https://testhr.vodoglobal.com/data/employee/profile/546/emp_profile_3312_2025-01-23-07:16:20.jpg", "name": "Mahmoud", "user_name": "Mahmoud_Ali", "phone": "[\"+12334453456\"]", "email": "vaxado5648@bflcafe.com", "active": 1, "currency_id": null, "company_id": 259, "occupation_id": 73 } ] }, { "id": 123, "image": "https://testhr.vodoglobal.com/data/employee/profile/user.png", "name": "test department", "company_id": "259", "company_name": "تجريبى فودو", "calendar_id": null, "calendar_name": null, "active": "yes", "type": "main", "activation_date": null, "deactivation_date": null, "latitude": null, "longitude": null, "employees": [] }, { "id": 121, "image": "https://testhr.vodoglobal.com/data/employee/profile/user.png", "name": "test location", "company_id": "259", "company_name": "تجريبى فودو", "calendar_id": null, "calendar_name": null, "active": "yes", "type": "main", "activation_date": null, "deactivation_date": null, "latitude": "25.38737494", "longitude": "49.20154628", "employees": [] }, { "id": 120, "image": "https://testhr.vodoglobal.com/data/employee/profile/user.png", "name": "فثسف", "company_id": "259", "company_name": "تجريبى فودو", "calendar_id": null, "calendar_name": null, "active": "yes", "type": "main", "activation_date": "2025-02-09", "deactivation_date": "2025-02-10", "latitude": null, "longitude": null, "employees": [] }, { "id": 119, "image": "https://testhr.vodoglobal.com/data/employee/profile/user.png", "name": "test", "company_id": "259", "company_name": "تجريبى فودو", "calendar_id": "466", "calendar_name": "new admin calendar 5", "active": "yes", "type": "main", "activation_date": "2025-01-30", "deactivation_date": "2025-01-31", "latitude": null, "longitude": null, "employees": [ { "id": 3364, "user_id": 946, "image": "https://testhr.vodoglobal.com/data/employee/profile/554/emp_profile_3364_2025-02-02-04:38:15.jpg", "name": "علا احمد", "user_name": "Olaa", "phone": "[\"+96616515164\"]", "email": "test12323@gmail.com", "active": 1, "currency_id": null, "company_id": 259, "occupation_id": 47 } ] }, { "id": 115, "image": "https://testhr.vodoglobal.com/data/employee/profile/user.png", "name": "Human Resources edit", "company_id": "259", "company_name": "تجريبى فودو", "calendar_id": "382,383,384,393", "calendar_name": "0", "active": "yes", "type": "main", "activation_date": "2024-12-26", "deactivation_date": "2025-12-31", "latitude": null, "longitude": null, "employees": [ { "id": 3327, "user_id": 921, "image": "https://testhr.vodoglobal.com/data/employee/profile/497/emp_profile_3327_2024-12-17-08:37:33.jpg", "name": "Ammar Yasser", "user_name": "ammar898", "phone": "[\"+9665633333333\"]", "email": "losahe4350@kelenson.com", "active": 1, "currency_id": null, "company_id": 259, "occupation_id": 73 }, { "id": 3331, "user_id": 926, "image": "https://testhr.vodoglobal.com/data/employee/profile/599/emp_profile_3331_2025-03-13-09:06:42.jpg", "name": "Marco", "user_name": "Marco_1", "phone": "[\"+96633554466\"]", "email": "yiyoxe1194@ronete.com", "active": 1, "currency_id": null, "company_id": 259, "occupation_id": 47 } ] }, { "id": 114, "image": "https://testhr.vodoglobal.com/data/employee/profile/523/adminprofile_114_2024-12-23-11:42:15.jpg", "name": "adminbistration 1", "company_id": "259", "company_name": "تجريبى فودو", "calendar_id": "380", "calendar_name": "calendar 1 edited", "active": "yes", "type": "main", "activation_date": null, "deactivation_date": null, "latitude": null, "longitude": null, "employees": [ { "id": 3322, "user_id": 860, "image": "https://testhr.vodoglobal.com/data/employee/profile/493/emp_profile_3322_2024-12-17-06:56:53.jpg", "name": "Hamdy", "user_name": "hamdy_emad", "phone": "[\"+12312452455\"]", "email": "jesapep782@pokeline.com", "active": 0, "currency_id": null, "company_id": 259, "occupation_id": 47 } ] }, { "id": 113, "image": "https://testhr.vodoglobal.com/data/employee/profile/user.png", "name": "administration 0", "company_id": "259", "company_name": "تجريبى فودو", "calendar_id": "379", "calendar_name": "calendar 0 edited1", "active": "yes", "type": "main", "activation_date": null, "deactivation_date": null, "latitude": null, "longitude": null, "employees": [] } ], "pagination": { "total": 20, "per_page": 10, "current_page": 1, "last_page": 2, "from": 1, "to": 10 } } }

Request

Query Params

keyword

string

optional

serach by name

Example:

tes

company_id

string

optional

serach by compant id

Example:

259

admin_id

string

optional

to get one administration

Example:

126

per_page

string

optional

Example:

Header Params

uuid

string

required

Example:

secure-business-key

string

required

Example:

string

required

Example:

application/json

user_token

string

required

Example:

Body Params application/json

object {0}

Examples

application/json

Body

status

boolean

required

message

string

required

response

object

required

administrations

array [object {14}]

required

pagination

object

required

GET/ administration

Request Parameters#

Response#

Request

Responses

Request Parameters

Response