REST-API.md

@@ -105,3 +105,46 @@ Endpoint using to register new user
         }
     
 
+## GET /api/profile
+Endpoint using to retrieve logged user profile
+
+* **requires authentication**: 
+
+    `True`
+* **uri**:
+
+    `/api/profile`
+
+* **success response example**:
+
+    `status_code: 200`
+
+        {
+            "success": "True",
+            "status_code": 200,
+            "message": "User profile fetched successfully",
+            "profile": {
+                "username": "j.doe",
+                "first_name": "John",
+                "last_name": "Doe"
+            }
+        }
+* **error response examples**:
+
+    `status_code: 401`
+
+        {
+            "detail": "Authentication credentials were not provided."
+        }
+        
+        
+     or
+        
+     `status_code: 404`
+     
+         {
+            "success": "False",
+            "status_code": 404,
+            "message": "User profile does not exist",
+            "error": "UserProfile matching query does not exist." 
+         }