GET residents/{userName}

Retrieves the resident's profile and his/her leased units

Request Information

URI Parameters

Name	Description	Type	Additional information
userName	Name of the resident	string	Required

Body Parameters

None.

Response Information

Resource Description

Returns a UserProfile object

ResidentProfileView

Name	Description	Type	Additional information
UserId	User Id	integer	Required
UserName	Resident's login name	string	Required Max length: 32
FirstName	Resident's first name	string	Required Max length: 30
LastName	Resident's last name	string	Required Max length: 30
BirthDate	Resident's birthdate	date	Required
Email	Resident's email	string	Max length: 250
Address	Resident's address	string	Max length: 512
HomePhone	Resident's home phone	string	Max length: 25
CellPhone	Resident's cell phone	string	Max length: 25
WorkPhone	Resident's work phone	string	Max length: 25
SecurityQuestion1	Secuirty question 1	string	Max length: 254
SecurityAnswer1	Security Answer to question 1	string	Max length: 254
SecurityQuestion2	Seucirty question 2	string	Max length: 254
SecurityAnswer2	Security answer to question 2	string	Max length: 254
Gender	Sex	string	Max length: 10
HouseholdIncome	Household income	string	None.
MaritalStatus	Marital status	string	Max length: 15
RentReminderEnabled	Email to resident a rent reminder	boolean	None.
RentReminderEmail	Rent reminder email	string	Max length: 250
UserPicture	User Picture	string	None.
UserPictureFormat	User Picture format	string	None.
NotifyByEmail	Alert user about a pending parcel by email	boolean	None.
NotifyByPNS	Alert user about a pending parcel by push notification	boolean	None.
NotifyByText	Alert user about a pending parcel by text	boolean	None.
ADAEnabled		boolean	None.
Units	List of resident's unit(s)	Collection of UnitView	None.

Response Formats

application/json, text/json

Sample:

{
  "UserId": 1,
  "UserName": "sample string 2",
  "FirstName": "sample string 3",
  "LastName": "sample string 4",
  "BirthDate": "2025-05-19T02:25:18.1347657-07:00",
  "Email": "sample string 6",
  "Address": "sample string 7",
  "HomePhone": "sample string 8",
  "CellPhone": "sample string 9",
  "WorkPhone": "sample string 10",
  "SecurityQuestion1": "sample string 11",
  "SecurityAnswer1": "sample string 12",
  "SecurityQuestion2": "sample string 13",
  "SecurityAnswer2": "sample string 14",
  "Gender": "sample string 15",
  "HouseholdIncome": "sample string 16",
  "MaritalStatus": "sample string 17",
  "RentReminderEnabled": true,
  "RentReminderEmail": "sample string 19",
  "UserPicture": "sample string 20",
  "UserPictureFormat": "sample string 21",
  "NotifyByEmail": true,
  "NotifyByPNS": true,
  "NotifyByText": true,
  "ADAEnabled": true,
  "Units": [
    {
      "UnitId": 1,
      "UnitNumber": "sample string 2",
      "Community": "sample string 3",
      "LeasingOfficePhone": "sample string 4",
      "IsPrimary": true,
      "MonthlyBillingStatements": true,
      "BillingLastUpdate": "2025-05-19T02:25:18.1503901-07:00",
      "AppEnabled": true,
      "ParcelPendingServiceEnabled": true,
      "ResidentAccountNumber": "sample string 10",
      "UniqueEmailId": "sample string 11",
      "AppAvailable": true,
      "OneSiteId": 13,
      "ResidentMemberId": 14,
      "HouseholdId": 15,
      "LeaseId": 16
    },
    {
      "UnitId": 1,
      "UnitNumber": "sample string 2",
      "Community": "sample string 3",
      "LeasingOfficePhone": "sample string 4",
      "IsPrimary": true,
      "MonthlyBillingStatements": true,
      "BillingLastUpdate": "2025-05-19T02:25:18.1503901-07:00",
      "AppEnabled": true,
      "ParcelPendingServiceEnabled": true,
      "ResidentAccountNumber": "sample string 10",
      "UniqueEmailId": "sample string 11",
      "AppAvailable": true,
      "OneSiteId": 13,
      "ResidentMemberId": 14,
      "HouseholdId": 15,
      "LeaseId": 16
    }
  ]
}