Retrieve Profile Details

Retrieves the authenticated customer's profile information.

HTTP Request

Retrieve Profile:

GET/api/shop/customers/me

Authorization

Authorization

• Required: Yes
• Permission: Authenticated Customer
• Authentication: Token-based (`Authorization: Token <your_api_key>`)

Example Requests

🐍 Python

1import requests
2
3# Get customer profile
4response = requests.get('http://www.example.com/api/shop/customers/me', 
5  headers={'Authorization': 'Token <your_api_key>'}
6)
7print(response.json())

🌐 Curl

1# Get customer profile
2curl "http://www.example.com/api/shop/customers/me" -H "Authorization: Token <your_api_key>"

Status Codes

Code	Description
200	Profile retrieved successfully
401	Unauthorized — authentication required
400	Bad request — validation errors
500	Internal server error

Response Fields

Field	Type	Description
id	Integer	Unique ID of the customer
username	String	Customer's username
mobile_number	String	Customer's phone number (read-only)
email	String	Customer's email address (read-only)
is_email_verified	Boolean	Customer's email verified or not (read-only)
avatar	String	URL to customer's avatar image
first_name	String	Customer's first name
last_name	String	Customer's last name
full_name	String	Customer's full name (computed field)
gender	String	Customer's gender
is_profile_completed	Boolean	Whether the profile is completed
invite_code	String	Customer's invite code
invitees_count	Integer	The count of customers that invited by this customer
invitees	Array[Object]	List of customers that invited by this customer

Invitees Object Structure

Field	Type	Description
id	Integer	Unique ID of the invited customer
username	String	Invited customer's username
full_name	String	Invited customer's full name (computed field)

Example Response

{
    "id": 1,
    "username": "behrooz3500",
    "mobile_number": "09308744204",
    "email": "behrooz21@hotmail.com",
    "avatar": "http://example.com/media/users/avatars/photo22132188258.jpg",
    "first_name": "behrooz",
    "last_name": "ghorbanie",
    "full_name": "behrooz ghorbanie",
    "gender": "male",
    "is_profile_completed": true,
    "invite_code": "DLrNVOM",
    "invitees_count": 2,
    "invitees": [
        {
          "id": 12,
          "username": "sara",
          "full_name": "سارا حسن زاده",
        },
        {
          "id": 54,
          "username": "sina",
          "full_name": "سینا خاشعی",
        }
    ]
}