Profile API
Public profile retrieval plus profile edits, memberships, comments, spaces, and notification preferences.
Authentication
Profile routes are portal routes. Mutating routes enforce ownership or moderation rules inside the controller.
Endpoints
| Method | Path | Edition | Operation | Controller |
|---|---|---|---|---|
GET | /profile/{username} | Core | Get Profile | ProfileController@getProfile |
POST | /profile/{username} | Core | Update Profile | ProfileController@updateProfile |
PUT | /profile/{username} | Core | Patch Profile | ProfileController@patchProfile |
GET | /profile/{username}/spaces | Core | List Profile Spaces | ProfileController@getSpaces |
GET | /profile/{username}/memberships | Core | List Profile Memberships | ProfileController@getAllMemberships |
GET | /profile/{username}/notification-preferences | Core | Get Notification Preferences | ProfileController@getNotificationPreferance |
POST | /profile/{username}/notification-preferences | Core | Save Notification Preferences | ProfileController@saveNotificationPreferance |
GET | /profile/{username}/followers | PRO | List Profile Followers | FollowController@getFollowers |
GET | /profile/{username}/followings | PRO | List Profile Followings | FollowController@getFollowings |
GET | /profile/{username}/blocked-users | PRO | List Profile Blocked Users | FollowController@getBlockedUsers |
POST | /profile/{username}/follow | PRO | Follow Profile User | FollowController@follow |
POST | /profile/{username}/unfollow | PRO | Unfollow Profile User | FollowController@unfollow |
POST | /profile/{userId}/toggle-follow | PRO | Toggle Profile Follow | FollowController@toggleFollow |
POST | /profile/{username}/block | PRO | Block Profile User | FollowController@block |
POST | /profile/{username}/unblock | PRO | Unblock Profile User | FollowController@unblock |
POST | /profile/{username}/notification | PRO | Toggle Profile Notification | FollowController@toggleNotification |