Units

Get all units

GET
Get all units

Query parameters

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

Response

This endpoint returns an object
meta
object
results
list of objects
GET
1curl https://api.propexo.com/v1/units \
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 "created_at": "2024-03-21T15:38:08.337Z",
15 "updated_at": "2024-03-22T10:59:45.119Z",
16 "x_id": "sample_value",
17 "x_property_id": "sample_value",
18 "integration_id": "clwh5u07w000508me66sfh3um",
19 "integration_vendor": "(PMS ENUM VALUE)",
20 "property_id": "clwi5xiix000008l6ctdgafyh",
21 "last_seen": "2024-03-22T10:59:45.119Z",
22 "bathrooms": "sample_value",
23 "bedrooms": "sample_value",
24 "building_name": "sample_value",
25 "building_number": "null",
26 "city": "Boston",
27 "country": "null",
28 "floor_plan_code": "null",
29 "floor_plan_name": "null",
30 "floor": "null",
31 "is_available": true,
32 "is_furnished": true,
33 "is_listed": true,
34 "is_vacant": true,
35 "number": "sample_value",
36 "rent_amount_market_in_cents": 350000,
37 "rent_amount_max_in_cents": 1.1,
38 "rent_amount_min_in_cents": 1.1,
39 "square_feet": 1,
40 "state": "MA",
41 "street_address_1": "sample_value",
42 "street_address_2": "sample_value",
43 "address_1": "123 Main St",
44 "address_2": "address_2",
45 "zip": "02116",
46 "pets_allowed": true,
47 "dogs_allowed": true,
48 "cats_allowed": true,
49 "pet_policy": "null"
50 }
51 ]
52}