Get all units

Query parameters

order-bystringOptional

Order the results by a field. Optionally include asc or desc preceded by a colon (default is asc). Example: ?order-by=updated_at:desc

offsetintegerOptional

Can be used for paginating results

limitintegerOptional

A number between 1 and 250 to determine the number of results to return in a single query

x_idstringOptional

The external unit id

x_property_idstringOptional

Deprecated: Use the Propexo property_id instead

location_idstringOptional

The Propexo unique identifier for the location associated with the property. This is the location specified in RentManager

property_idstringOptional

The Propexo property id

integration_idstringOptional

The Propexo integration id

integration_vendorenumOptional

The integration vendor for the unit.

unit_numberstringOptional

The unit number of the service request. When using this, the Propexo property_id filter must be added as well.

Response

This endpoint returns an object.

metaobject

resultslist of objects

Errors

1 curl https://api.propexo.com/v1/units/ \ 2 -H "Authorization: Bearer <token>"

1 { 2 "meta": { 3 "orderBy": [ 4 {} 5 ], 6 "offset": 42, 7 "limit": 42, 8 "hasMore": true, 9 "total": 42 10 }, 11 "results": [ 12 { 13 "id": "sample_value", 14 "created_at": "2024-07-01T00:00:00.000Z", 15 "updated_at": "2024-07-01T00:00:00.000Z", 16 "x_id": "sample_value", 17 "x_property_id": "sample_value", 18 "integration_id": "sample_value", 19 "integration_vendor": "sample_value", 20 "property_id": "sample_value", 21 "last_seen": "2024-07-01T00:00:00.000Z", 22 "bathrooms": "2.5", 23 "bathrooms_full": 2, 24 "bathrooms_half": 1, 25 "bedrooms": "2", 26 "building_name": "sample_value", 27 "building_number": "sample_value", 28 "city": "sample_value", 29 "country": "sample_value", 30 "floor_plan_code": "sample_value", 31 "floor_plan_name": "sample_value", 32 "floor": "sample_value", 33 "is_available": true, 34 "is_furnished": true, 35 "is_vacant": true, 36 "number": "sample_value", 37 "rent_amount_market_in_cents": 1.1, 38 "rent_amount_max_in_cents": 1.1, 39 "rent_amount_min_in_cents": 1.1, 40 "square_feet": 42, 41 "state": "sample_value", 42 "address_1": "sample_value", 43 "address_2": "sample_value", 44 "zip": "sample_value", 45 "pets_allowed": true, 46 "dogs_allowed": true, 47 "cats_allowed": true, 48 "pet_policy": "sample_value", 49 "is_listed": true, 50 "street_address_1": "sample_value", 51 "street_address_2": "sample_value" 52 } 53 ] 54 }

1	curl https://api.propexo.com/v1/units/ \
2	-H "Authorization: Bearer <token>"

1	{
2	"meta": {
3	"orderBy": [
4	{}
5	],
6	"offset": 42,
7	"limit": 42,
8	"hasMore": true,
9	"total": 42
10	},
11	"results": [
12	{
13	"id": "sample_value",
14	"created_at": "2024-07-01T00:00:00.000Z",
15	"updated_at": "2024-07-01T00:00:00.000Z",
16	"x_id": "sample_value",
17	"x_property_id": "sample_value",
18	"integration_id": "sample_value",
19	"integration_vendor": "sample_value",
20	"property_id": "sample_value",
21	"last_seen": "2024-07-01T00:00:00.000Z",
22	"bathrooms": "2.5",
23	"bathrooms_full": 2,
24	"bathrooms_half": 1,
25	"bedrooms": "2",
26	"building_name": "sample_value",
27	"building_number": "sample_value",
28	"city": "sample_value",
29	"country": "sample_value",
30	"floor_plan_code": "sample_value",
31	"floor_plan_name": "sample_value",
32	"floor": "sample_value",
33	"is_available": true,
34	"is_furnished": true,
35	"is_vacant": true,
36	"number": "sample_value",
37	"rent_amount_market_in_cents": 1.1,
38	"rent_amount_max_in_cents": 1.1,
39	"rent_amount_min_in_cents": 1.1,
40	"square_feet": 42,
41	"state": "sample_value",
42	"address_1": "sample_value",
43	"address_2": "sample_value",
44	"zip": "sample_value",
45	"pets_allowed": true,
46	"dogs_allowed": true,
47	"cats_allowed": true,
48	"pet_policy": "sample_value",
49	"is_listed": true,
50	"street_address_1": "sample_value",
51	"street_address_2": "sample_value"
52	}
53	]
54	}