Mentors

This guide explains how to interact with the admin manage the mentors crud.

Get Mentors

Endpoint

Method: GET
URL: /v1/admin/coaches

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Query Parameters

Parameter	Type	Description	Required	Default
search_text	string	Mentor's name	No	null
filter[active]	string	Mentor's is active	No	null
filter[gender]	string	Mentor's gender	No	null
filter[email_verified_at]	string	Mentor's email verified at	No	null
filter[rate]	string	Mentor's rate avrage	No	null
filter[is_special]	string	Mentor's is special	No	null
filter[status]	string	Mentor's status	No	null
filter[availability_status]	string	Mentor's availability status	No	null
filter[rejected_or_reviewed_status]	string	Mentor's rejected/reviewed status	No	null
filter[not_rejected_or_reviewed_status]	string	Mentor's not rejected/reviewed status	No	null
filter[firebase_status]	string	Mentor's firebase status	No	null
filter[country]	string	Mentor's country	No	null
filter[nationality]	string	Mentor's nationality	No	null
filter[level]	string	Mentor's level	No	null
filter[category]	string	Mentor's category	No	null
filter[created_at]	string	Mentor's created at date	No	null

Success Response

{
    "success": true,
    "message": "تم جلب بيانات المدرب بنجاح",
    "data": {
         "coaches": [
            {
                "id": "uuid",
                "name": "Ahhh Mohhh Ahhh",
                "email": "sss@sss.com",
                "avatar": "https://avatar.png",
                "phone": "566333000",
                "gender": "ذكر",
                "active": true,
                "status": "قيد المراجعة",
                "availabilityStatus": "OFFLINE",
                "emailVerifiedAt": false,
                "isSpecial": false,
                "sessionsCount": 0,
                "level": "750",
                "country": {
                    "id": "uuid",
                    "name": "السعودية"
                },
                "nationality": {
                    "id": "uuid",
                    "name": "سعودي"
                },
                "categoryName": [
                    "استشارة حرة"
                ],
                "rate": "0.0",
                "createdAt": "2025-03-25 16:02:15",
                "isFrozen": false
            },
         ]
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Show Mentor

Endpoint

Method: GET
URL: /v1/admin/coaches/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Success Response

{
    "success": true,
    "message": "تم جلب البيانات بنجاح.",
    "data": {
        "id": "uuid",
        "name": "Ahhh Mohhh Ahhh",
        "firstName": "Ahhh",
        "middleName": "Mohhh",
        "lastName": "Ahhh",
        "email": "sss@sss.com",
        "role": "coach",
        "status": "قيد المراجعة",
        "isFrozen": false,
        "availabilityStatus": "OFFLINE",
        "avatar": "https://avatar.png",
        "residencePlace": null,
        "phone": "566333000",
        "gender": "ذكر",
        "birthDate": "2000-05-11",
        "rejectReason": null,
        "nationality": {
            "id": "uuid",
            "name": "سعودي"
        },
        "active": true,
        "emailVerifiedAt": false,
        "createdAt": "2025/03/25",
        "coachLevel": {
            "id": "uuid",
            "name": "750"
        },
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Update Mentor

Endpoint

Method: PATCH
URL: /v1/admin/coaches/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
first_name	string	Mentor's first name	No
middle_name	string	Mentor's middle name	No
last_name	string	Mentor's last name	No
email	string	Mentor's email address	No
password	string	Mentor's password	No
password_confirmation	string	Mentor's password confirmation	No
phone	string	Mentor's phone	No
gender	string	Mentor's gender	No
birth_date	string	Mentor's birth date	No
nationality_id	string	Mentor's national	No
country_id	string	Mentor's country	No
residence_place	string	Mentor's residence place	No
specialization	string	Mentor's specialization	No
certificate_name	string	Mentor's certificate name	No
university	string	Mentor's university	No
is_special	string	Mentor's is special	No
status	string	Mentor's status	No
availability_status	string	Mentor's availability status	No
reject_reason	string	Mentor's reject reason	No
avatar	file	Customer's avatar	No
clear_avatar	string	User's clear avatar	No
about	string	About Mentor	No
qualified_id	string	Mentor's qualified	No
coach_level_id	string	Mentor's level	No
degree_id	string	Mentor's degree	No
university	string	Mentor's university	No
certificate_name	string	Mentor's certificate name	No
specialization	string	Mentor's specialization	No
languages_ids	string	Mentor's languages	No
categories_ids	string	Mentor's categories	No
certificate_files	file	Mentor's certificate files	No
deleted_certificate_files	file	Mentor's delete certificate files	No
cv_files	file	Mentor's cv files	No
deleted_cv_files	file	Mentor's delete cv files	No
has_accreditation	bool	Mentor's has accreditation	No
years_of_experience	string	Mentor's years of experience	No
experiences	string	Mentor's experiences	No
interests	string	Mentor's interests	No
achievements	string	Mentor's achievements	No
community_participation	string	Mentor's community participation	No
experience_file	file	User's avatar	No
orientation_coach	bool	Mentor's orientation	No
orientation_availability	array	Mentor's orientation availability	No
orientation_availability.weekdays	array	Mentor's orientation availability weekdays	No
orientation_availability.from	array	Mentor's orientation availability from	No
orientation_availability.to	array	Mentor's orientation availability to	No
is_frozen	bool	Mentor's is frozen	No
frozen_days	string	Mentor's frozen days	No

Success Response

{
    "success": true,
    "message": "تم تحديث البيانات بنجاح.",
    "data": {
        "id": "uuid",
        "name": "سالم Mohhh Ahhh",
        "firstName": "سالم",
        "middleName": "Mohhh",
        "lastName": "Ahhh",
        "email": "sss@sss.com",
        "role": "coach",
        "status": "قيد المراجعة",
        "isFrozen": false,
        "availabilityStatus": "OFFLINE",
        "avatar": "https://avatar.png",
        "residencePlace": null,
        "phone": "566333000",
        "gender": "ذكر",
        "birthDate": "2000-05-11",
        "rejectReason": null,
        "nationality": {
            "id": "uuid",
            "name": "سعودي"
        },
    },
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Update Mentor Index

Endpoint

Method: PATCH
URL: /v1/admin/coaches

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
ids	string	Mentor's id	Yes
status	string	Mentor's status	Yes

Success Response

{
    "success": true,
    "message": "تم تحديث البيانات بنجاح.",
    "data": [],
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Delete Mentor

Endpoint

Method: DELETE
URL: /v1/admin/coaches

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
ids	array	Customer's id	No

Success Response

{
    "success": true,
    "message": "تم حذف البيانات بنجاح.",
    "data": [],
    "statusCode": 200
}

Error Response

Unauthorized (401)

{
    "success": false,
    "message": "يجب عليك تسجيل الدخول",
    "data": [],
    "statusCode": 401
}

Update Mentor's Password

Endpoint

Method: PATCH
URL: /v1/admin/update-couch-password/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required
password	string	Mentor's password (optional)	No

Success Response

{
    "success": true,
    "message": "تمت إعادة تعيين كلمة المرور بنجاح",
    "data": {
        "password": "VnU9w&cW19"
    },
    "statusCode": 200
}

Export Mentors

Endpoint

Method: GET
URL: /v1/admin/coaches-export

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Success Response

Excel File

Download Mentor's Files

Endpoint

Method: GET
URL: /v1/admin/download-coach-files/{id}

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Query Parameters

Parameter	Type	Description	Required
type	string	Mentor's file type (cv / certificate / experience)	Yes

Success Response

Zip File

Get Mentors​

Endpoint​

Request Headers​

Query Parameters​

Success Response​

Error Response​

Unauthorized (401)​

Show Mentor​

Endpoint​

Request Headers​

Success Response​

Error Response​

Unauthorized (401)​

Update Mentor​

Endpoint​

Request Headers​

Request Body​

Success Response​

Error Response​

Unauthorized (401)​

Update Mentor Index​

Endpoint​

Request Headers​

Request Body​

Success Response​

Error Response​

Unauthorized (401)​

Delete Mentor​

Endpoint​

Request Headers​

Request Body​

Success Response​

Error Response​

Unauthorized (401)​

Update Mentor's Password​

Endpoint​

Request Headers​

Request Body​

Success Response​

Export Mentors​

Endpoint​

Request Headers​

Success Response​

Download Mentor's Files​

Endpoint​

Request Headers​

Query Parameters​

Success Response​

Get Mentors

Endpoint

Request Headers

Query Parameters

Success Response

Error Response

Unauthorized (401)

Show Mentor

Endpoint

Request Headers

Success Response

Error Response

Unauthorized (401)

Update Mentor

Endpoint

Request Headers

Request Body

Success Response

Error Response

Unauthorized (401)

Update Mentor Index

Endpoint

Request Headers

Request Body

Success Response

Error Response

Unauthorized (401)

Delete Mentor

Endpoint

Request Headers

Request Body

Success Response

Error Response

Unauthorized (401)

Update Mentor's Password

Endpoint

Request Headers

Request Body

Success Response

Export Mentors

Endpoint

Request Headers

Success Response

Download Mentor's Files

Endpoint

Request Headers

Query Parameters

Success Response