Residents

Get a resident by ID

GET
https://api.propexo.com/v1/residents/:id
Get a resident by ID

Path parameters

id
string

Query parameters

order-by
optional string
offset
optional integer
limit
optional integer

Response

This endpoint return an object.
meta
object
results
object
GET
/v1/residents/:id
curl https://api.propexo.com/v1/residents/id \
-H "Authorization: Bearer <token>"
Response
{
"meta": {
"orderBy": [
{}
],
"offset": 1,
"limit": 1,
"hasMore": true,
"total": 1
},
"results": {
"id": "id",
"created_at": "created_at",
"updated_at": "updated_at",
"x_id": "x_id",
"integration_id": "integration_id",
"integration_vendor": "integration_vendor",
"property_id": "property_id",
"last_seen": "last_seen",
"x_lease_id": "x_lease_id",
"leases_meta_data": [
{
"lease_id": "lease_id"
}
],
"address_1_alternate": "address_1_alternate",
"address_1": "address_1",
"address_2_alternate": "address_2_alternate",
"address_2": "address_2",
"balance_in_cents": 1.1,
"city_alternate": "city_alternate",
"city": "city",
"country_alternate": "country_alternate",
"country": "country",
"date_of_birth": "date_of_birth",
"email_1": "email_1",
"email_2": "email_2",
"first_name": "first_name",
"is_employee": true,
"last_name": "last_name",
"late_balance_in_cents": 1.1,
"middle_name": "middle_name",
"notes": "notes",
"phone_1_type": "FAX",
"phone_1": "phone_1",
"phone_2_type": "FAX",
"phone_2": "phone_2",
"state_alternate": "state_alternate",
"state": "state",
"zip_alternate": "zip_alternate",
"zip": "zip"
}
}