Skip to main content
Below is our standard data structure for a resident:
string
default:"none"
The name of the community for the resident you want to create.
string
default:"none"
The external reference of the community for the resident you want create.
string
default:"none"
The external reference for the unit corresponding to the resident you want to create.
string
default:"none"
The external reference for the vacancy corresponding to the resident you want to create.
date
The move in date for the vacancy corresponding to the resident you want to create.
string
default:"none"
The start date for the vacancy corresponding to the resident you want to create.
string
default:"none"
The end date for the vacancy corresponding to the resident you want to create.
string
The type of the property associated with the resident to be created.Can be:
  • SF (Single Family)
  • GS (Garden Style)
  • MR (Mid Rise)
  • HR (High Rise)
string
default:"none"
The end date unit corresponding to the resident you want to create.
string
default:"none"
The number of bedrooms for the unit corresponding to the resident you want to create.
string
default:"none"
The number of bathrooms for the unit corresponding to the resident you want to create.
float
The square feet surface for the unit corresponding to the resident you want to create.
string
default:"none"
The first line of the address for the unit corresponding to the resident you want to create.
string
default:"none"
The second line of the address for the unit corresponding to the resident you want to create.
string
default:"none"
The city of the address for the unit corresponding to the resident you want to create.
string
default:"none"
The state of the address for the unit corresponding to the resident you want to create.
string
default:"none"
The country of the address for the unit corresponding to the resident you want to create.
string
default:"none"
The postal code of the address for the unit corresponding to the resident you want to create.
string
default:"none"
The longitude of the address for the unit corresponding to the resident you want to create.
string
default:"none"
The latitude of the address for the unit corresponding to the resident you want to create.
string
default:"none"
The external reference for the resident you want to create.
string
default:"none"
The first name of the resident you want to create.
string
default:"none"
The last name of the resident you want to create.
string
default:"none"
Role of the resident.Can be:
  • Prospect
  • Applicant
  • Leasholder
  • Occupant
  • Guarantor
  • Minor
  • ExTenant
string
default:"none"
The email address of the resident you want to create.
string
default:"none"
An alternative email address for the resident you want to create.
string
default:"none"
A third alternative email address for the resident you want to create.
string
default:"none"
The phone number of the resident you want to create.
string
default:"none"
An alternative phone number for the resident you want to create.
string
default:"none"
A third alternative phone number for the resident you want to create.
string
default:"none"
The cell phone number of the resident you want to create.
string
default:"none"
An alternative cell phone number for the resident you want to create.
string
default:"none"
A third alternative cell phone number of the resident you want to create.
string
default:"none"
The middle name of the resident.
date
default:"none"
The date of birth of the resident.
string
default:"none"
The gender of the resident.
string
default:"none"
The name of the company where the resident is employed.
string
default:"none"
The job title of the resident at their company.
string
default:"none"
The first line of the company address for the resident.
string
default:"none"
The city of the company address for the resident.
string
default:"none"
The state of the company address for the resident.
string
default:"none"
The zip code of the company address for the resident.
string
default:"none"
The phone number of the resident’s company.
string
default:"none"
The email address of the resident at their company.
date
default:"none"
The start date of the resident’s employment at their company.