Users Endpoints

Get User

File: api/user.php Method: POST Auth: Required JWT (POST body)

Returns the authenticated user’s full profile. This is the main “refresh user” endpoint called on app launch and resume. Includes:

• Basic profile (uuid, name, email, picture, contact_no, city, birthday, gender, uni_year/grad_year)
• House search filters
• Viewing rewards and notification counts
• Housemate group size
• Roomie disabled status
• Rental action status
• Bills callback request status
• US-specific: Moderation data, review periods, college major, fraternity/sorority, rep status
• UK-specific: House searching status

Records a user session on each call.

Update Profile

File: api/updateProfile.php Method: POST Auth: Required JWT

Updates user profile fields (name, phone, image, etc.). Handles profile picture upload to S3.

Delete User

File: api/deleteUser.php Method: POST Auth: Required JWT

Deletes the user’s account.

Change City

File: api/changeCity.php Method: POST Auth: Required JWT

Changes the user’s city.

Change Phone Number

File: api/changePhoneNumber.php Method: POST Auth: Required JWT

Updates the user’s phone number.

Update University

File: api/updateUniversity.php Method: POST Auth: Required JWT

Updates the user’s university information.

Update Grad Year

File: api/updateGradYear.php Method: POST Auth: Required JWT

Updates the user’s graduation year.

Update User Referral Code

File: api/updateUserReferralCode.php Method: POST Auth: Required JWT

Updates the user’s personal referral code.

Tenant Image

File: api/tenantImage.php Method: POST Auth: Required JWT

Handles tenant profile image upload.

Friends

Get Friends

File: api/friends.php Method: POST Auth: Required JWT

Returns the user’s friend list.

Send Friend Request

File: api/sendFriendRequest.php Method: POST Auth: Required JWT

Sends a friend request to another user.

Friend Requests

File: api/friendRequests.php Method: POST Auth: Required JWT

Returns pending friend requests for the user.

Accept Request

File: api/acceptRequest.php Method: POST Auth: Required JWT

Accepts a friend request.

Decline Request

File: api/declineRequest.php Method: POST Auth: Required JWT

Declines a friend request.

Remove Friend

File: api/removeFriend.php Method: POST Auth: Required JWT

Removes a friend.

Friend Delete

File: api/friendDelete.php Method: POST Auth: Required JWT

Deletes a friend relationship.

Find Housr Users

File: api/findHousrUsers.php Method: POST Auth: Required JWT

Searches for Housr users (to add as friends).

Groups (Housemate Groups)

Join Group

File: api/joinGroup.php Method: POST Auth: Required JWT

Joins a housemate group (can be triggered during login with housemateGroupId).

Get Group Members

File: api/getGroupMembers.php Method: POST Auth: Required JWT

Returns members of the user’s housemate group.

Change Group Size

File: api/changeGroupSize.php Method: POST Auth: Required JWT

Changes the target group size.

Check User in Group

File: api/checkUserInGroup.php Method: POST Auth: Required JWT

Checks if a user is in any housemate group.

Invitations

Invite

File: api/invite.php Method: POST Auth: Required JWT

Sends an invitation to join the app.

Quick Invite

File: api/quickInvite.php Method: POST Auth: Required JWT

Quick invite flow.

Send Invite SMS

File: api/sendInviteSMS.php Method: POST Auth: Required JWT

Sends an SMS invitation.

Decline Invitation

File: api/declineInvitation.php Method: POST Auth: Required JWT

Declines an invitation.

Referrals

Use Referral Code

File: api/useReferralCode.php Method: POST Auth: Required JWT

Redeems a referral code.

Redeem Ref Code

File: api/refCodeRedeem.php Method: POST Auth: Required JWT

Redeems a referral code (alternative endpoint).

Refs

File: api/refs.php Method: POST Auth: Required JWT

Returns referral information.

User Rep

File: api/userRep.php Method: POST Auth: Required JWT

Returns user rep (ambassador) status.

Miscellaneous

House Searching

File: api/houseSearching.php Method: POST Auth: Required JWT

Updates the user’s house searching status.

Tutorial Complete

File: api/tutorialComplete.php Method: POST Auth: Required JWT

Marks the app tutorial as complete.

Set Tour Explainer Complete

File: api/setTourExplainerComplete.php Method: POST Auth: Required JWT

Marks the tour explainer as viewed.

Map Tutorial

Files: api/getMapTutorialComplete.php, api/setMapTutorialComplete.php Method: POST Auth: Required JWT

Gets/sets map tutorial completion status.

Track Action

File: api/trackAction.php Method: POST Auth: Required JWT

Tracks a user action (analytics).

NPS Rating

File: api/npsRating.php Method: POST Auth: Required JWT

Submits an NPS (Net Promoter Score) rating.

Geofences

Files: api/geofences.php, api/geofenceEntered.php Method: POST

Geofence definitions and entry tracking.

Feature Flags

File: api/featureFlags.php Method: GET Auth: None

Returns all feature flags as a {feature: boolean} map. Public endpoint.

Global Variables

File: api/getGlobalVariables.php Method: POST

Returns global configuration variables.