User Details

GET

https://app.gotreek.com/api/profile

Profile

Last modified:2025-12-25 15:22:04

Profile details endpoint for the authenticated user, with optional account statistics.

💡

Authentication

Bearer token authentication is required.

Returns profile data only for the currently authenticated user; no user ID parameter is accepted.

💡

Profile & company data

Returns basic profile fields (name, email, phone, role, avatar URL) and company information (name, city, registration and tax numbers, main store URL).

Includes wallet information (raw balance in cents, formatted balance, and a flag indicating whether the stored balance is correct).

📌

Optional statistics

If include_stats is omitted or set to 0, statistics are not calculated to keep the response lightweight.

Request

Authorization

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://app.gotreek.com/api/auth/login

Query Params

Header Params

Responses

🟢200

application/json

User profile retrieved successfully

Body

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://app.gotreek.com/api/profile?include_stats' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <token>'

Response Example

{
    "success": true,
    "profile": {
        "id": 1,
        "first_name": "Ahmed",
        "last_name": "Al-Mansouri",
        "full_name": "Ahmed Al-Mansouri",
        "email": "ahmed@example.com",
        "phone": "+966501234567",
        "avatar": "https://api.example.com/storage/avatars/user-1.jpg",
        "date_of_birth": "1990-05-15",
        "role": "merchant",
        "email_verified_at": "2024-01-15T09:30:00Z",
        "created_at": "2024-01-01T00:00:00Z",
        "updated_at": "2024-12-01T10:30:00Z"
    },
    "company_info": {
        "company_name": "Al-Mansouri Trading Co.",
        "commercial_registration_number": "1234567890",
        "tax_number": "300123456789001",
        "company_city": "Riyadh",
        "rate_cost": 1500
    },
    "wallet_info": {
        "balance": 125000,
        "balance_formatted": 1250,
        "is_balance_correct": true
    },
    "statistics": {
        "total_orders": 156,
        "total_merchants": 3,
        "total_warehouses": 2,
        "total_spent": 75000,
        "account_age_days": 334
    }
}

Modified at 2025-12-25 15:22:04

Merchants Details

Update User