The Tenancy Person object
idstringrequired
typestringrequired
Possible values: [tenancy_people]
attributes required
namestring
The full name of the person. This is read-only and derived from other fields.
Example:
Sam Olsentitlestring
The person's title (e.g., Mr, Mrs, Miss, Ms, Dr).
Example:
Msfirst_namestring
The person's first name.
Example:
Sammiddle_namestringnullable
The person's middle name, if applicable.
Example:
Alexlast_namestring
The person's last name.
Example:
Olsonresidently_mailemail
The person's Residently email address
Example:
sam.olsen.1n4@residentlymail.comemailemail
The person's personal email address.
Example:
sam.olsen@example.commobilestring
The person's mobile phone number.
Example:
+447700900123date_of_birthdate
The person's date of birth (ISO 8601 format: YYYY-MM-DD).
Example:
1990-05-15rolestring
The person's role in the system.
Possible values: [resident, occupier, guarantor]
Example:
residentprovider_idstringnullable
An external provider reference associated with the person, if applicable.
Example:
abc123metadataobject
Additional metadata for the tenancy person
Example:
{"field_1":"value1","field_2":"value2"}created_atdate-time
updated_atdate-time
The Tenancy Person object
{
"id": "string",
"type": "tenancy_people",
"attributes": {
"name": "Sam Olsen",
"title": "Ms",
"first_name": "Sam",
"middle_name": "Alex",
"last_name": "Olson",
"residently_mail": "sam.olsen.1n4@residentlymail.com",
"email": "sam.olsen@example.com",
"mobile": "+447700900123",
"date_of_birth": "1990-05-15",
"role": "resident",
"provider_id": "abc123",
"metadata": {
"field_1": "value1",
"field_2": "value2"
},
"created_at": "2024-07-29T15:51:28.071Z",
"updated_at": "2024-07-29T15:51:28.071Z"
}
}