FairePlace Property Management API
string | null · uuidstring | null · maxLength: 10string | nullstring | null · maxLength: 255string | null · enumstring | null · maxLength: 255string | null · maxLength: 50string | null · maxLength: 50string | null · maxLength: 255string | null · maxLength: 50string | null · maxLength: 255string | null · maxLength: 255string | null · maxLength: 20string | null · maxLength: 255string | null · maxLength: 20string | null · maxLength: 20string | null · maxLength: 20string | null · emailstring | nullstring | null · date-timestring | null · date-time
Properties for Individual owner:string | null · uuidstring | null · maxLength: 10string | nullstring | null · maxLength: 255string | null · enumstring | null · maxLength: 255string | null · maxLength: 50string | null · maxLength: 50string | null · maxLength: 255string | null · maxLength: 50string | null · maxLength: 255string | null · maxLength: 255string | null · maxLength: 20string | null · maxLength: 255string | null · maxLength: 20string | null · maxLength: 20string | null · maxLength: 20string | null · emailstring | nullstring | null · date-timestring | null · date-time
string · uuid · requiredstring | null · uuidstring | null · maxLength: 10string | nullstring | null · maxLength: 255string | null · enumstring | null · maxLength: 255string | null · maxLength: 50string | null · maxLength: 50string | null · maxLength: 255string | null · maxLength: 50string | null · maxLength: 255string | null · maxLength: 255string | null · maxLength: 20string | null · maxLength: 255string | null · maxLength: 20string | null · maxLength: 20string | null · maxLength: 20string | null · emailstring | nullstring | null · date-timestring | null · date-time
string · uuid · required
string · uuid · requiredstring | null · uuidstring | null · maxLength: 10string | nullstring | null · maxLength: 255string | null · enumstring | null · maxLength: 255string | null · maxLength: 50string | null · maxLength: 50string | null · maxLength: 255string | null · maxLength: 50string | null · maxLength: 255string | null · maxLength: 255string | null · maxLength: 20string | null · maxLength: 255string | null · maxLength: 20string | null · maxLength: 20string | null · maxLength: 20string | null · emailstring | nullstring | null · date-timestring | null · date-time
string · uuid · requiredstring | null · uuidstring | null · maxLength: 10string | nullstring | null · maxLength: 255string | null · enumstring | null · maxLength: 255string | null · maxLength: 50string | null · maxLength: 50string | null · maxLength: 255string | null · maxLength: 50string | null · maxLength: 255string | null · maxLength: 255string | null · maxLength: 20string | null · maxLength: 255string | null · maxLength: 20string | null · maxLength: 20string | null · maxLength: 20string | null · emailstring | nullstring | null · date-timestring | null · date-time
List owners
GET
https://api.faireplace.com/api
/owners
List owners › Responses
OK
object[]
idtitlelast_namefirst_nameowner_categoryEnum values:
individual
company
sc/sci
legal_nameregistration_numbercountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxmobile_phonelandline_phoneemailauth_user_idcreated_atupdated_atCreate owner
POST
https://api.faireplace.com/api
/owners
Create owner › Request Body
oneOf
Exactly one variant must match.
Decision Table
| Variant | Matching Criteria |
|---|---|
| No specific criteria | |
| requires: legal_name, registration_number |
Create owner › Responses
Created
idtitlelast_namefirst_nameowner_categoryEnum values:
individual
company
sc/sci
legal_nameregistration_numbercountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxmobile_phonelandline_phoneemailauth_user_idcreated_atupdated_atGet owner
GET
https://api.faireplace.com/api
/owners/{id}
path Parameters
idGet owner › Responses
OK
idtitlelast_namefirst_nameowner_categoryEnum values:
individual
company
sc/sci
legal_nameregistration_numbercountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxmobile_phonelandline_phoneemailauth_user_idcreated_atupdated_atUpdate owner
PUT
https://api.faireplace.com/api
/owners/{id}
path Parameters
idUpdate owner › Request Body
All fields are optional. If `owner_category` is `company` or `sc/sci`,
then `legal_name` and `registration_number` must be provided.
titlelast_namefirst_nameowner_categoryEnum values:
individual
company
sc/sci
legal_nameregistration_numbercountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxmobile_phonelandline_phoneemailauth_user_idUpdate owner › Responses
OK
idtitlelast_namefirst_nameowner_categoryEnum values:
individual
company
sc/sci
legal_nameregistration_numbercountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxmobile_phonelandline_phoneemailauth_user_idcreated_atupdated_atGet owner by place
GET
https://api.faireplace.com/api
/owners/places/{id}/owner
path Parameters
idGet owner by place › Responses
OK
idtitlelast_namefirst_nameowner_categoryEnum values:
individual
company
sc/sci
legal_nameregistration_numbercountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxmobile_phonelandline_phoneemailauth_user_idcreated_atupdated_atGet owner by estate
GET
https://api.faireplace.com/api
/owners/estates/{id}/owner
path Parameters
idGet owner by estate › Responses
OK
idtitlelast_namefirst_nameowner_categoryEnum values:
individual
company
sc/sci
legal_nameregistration_numbercountryaddress_complementstreet_numberstreet_namelocalitypostal_codecitypostal_boxmobile_phonelandline_phoneemailauth_user_idcreated_atupdated_at