Properties

Get all properties

GET
Get all properties

Query parameters

order-bystringOptional
offsetintegerOptional
limitintegerOptional
x_idstringOptional
x_property_idstringOptional
location_idstringOptional
integration_idstringOptional
integration_vendorenumOptional
The integration vendor for the property.

Response

This endpoint returns an object
meta
object
results
list of objects
GET
1curl https://api.propexo.com/v1/properties \
2 -H "Authorization: Bearer <token>"
200Retrieved
1{
2 "meta": {
3 "orderBy": [
4 {}
5 ],
6 "offset": 1,
7 "limit": 1,
8 "hasMore": true,
9 "total": 1
10 },
11 "results": [
12 {
13 "id": "clwktsp9v000008l31iv218hn",
14 "property_id": "clwi5xiix000008l6ctdgafyh",
15 "created_at": "2024-03-21T15:38:08.337Z",
16 "updated_at": "2024-03-22T10:59:45.119Z",
17 "x_id": "sample_value",
18 "x_property_id": "sample_value",
19 "integration_id": "clwh5u07w000508me66sfh3um",
20 "integration_vendor": "(PMS ENUM VALUE)",
21 "last_seen": "2024-03-22T10:59:45.119Z",
22 "x_created_at": "null",
23 "x_building_id": "null",
24 "building_number": "null",
25 "city": "Boston",
26 "country": "null",
27 "county": "null",
28 "is_active": true,
29 "manager_email": "name@example.com",
30 "manager_name": "Rachel Smith",
31 "manager_phone_1": "6175551234",
32 "manager_phone_1_type": "FAX",
33 "manager_phone_2": "6175551234",
34 "manager_phone_2_type": "MOBILE",
35 "name": "Estates at East Lake",
36 "number_of_units": 100,
37 "square_footage": 1,
38 "square_feet": 1,
39 "state": "MA",
40 "street_address_1": "sample_value",
41 "street_address_2": "sample_value",
42 "address_1": "123 Main St",
43 "address_2": "address_2",
44 "type": "null",
45 "type_raw": "multifam",
46 "type_normalized": "MULTI_FAMILY",
47 "website": "null",
48 "year_built": 2004,
49 "zip": "02116"
50 }
51 ]
52}