Get all unit details

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

location_idstringOptional

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

property_idstringOptional

The Propexo unique identifier for the property

integration_idstringOptional

The Propexo unique identifier for the integration

integration_vendorenumOptional

The property management system of record

Response

This endpoint returns an object.

metaobject

resultslist of objects

Errors

1 curl https://api.propexo.com/v1/units/details \ 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 "gross_square_feet": 42, 19 "rentable_square_feet": 42, 20 "integration_id": "sample_value", 21 "integration_vendor": "sample_value", 22 "property_id": "sample_value", 23 "last_seen": "2024-07-01T00:00:00.000Z", 24 "x_location_id": "sample_value", 25 "x_building_id": "sample_value", 26 "x_floor_plan_id": "sample_value", 27 "building_number": "sample_value", 28 "make_ready_date": "2024-07-01T00:00:00.000Z", 29 "made_ready_date": "2024-07-01T00:00:00.000Z", 30 "reserved_until_date": "2024-07-01T00:00:00.000Z", 31 "floor_plan_market_rent_in_cents": 1.1, 32 "unit_market_rent_in_cents": 1.1, 33 "base_rent_in_cents": 1.1, 34 "unit_number": "sample_value", 35 "description": "sample_value", 36 "floor_plan_name": "sample_value", 37 "accessible_hearing": true, 38 "accessible_mobility": true, 39 "accessible_vision": true, 40 "is_vacant": true, 41 "is_available": true, 42 "is_reserved": true, 43 "available_date": "2024-07-01T00:00:00.000Z", 44 "notes": "sample_value", 45 "city": "sample_value", 46 "country": "sample_value", 47 "state": "sample_value", 48 "address_1": "sample_value", 49 "address_2": "sample_value", 50 "zip": "sample_value", 51 "maximum_potential_lease_term": "sample_value", 52 "minimum_potential_lease_term": "sample_value" 53 } 54 ] 55 }

1	curl https://api.propexo.com/v1/units/details \
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	"gross_square_feet": 42,
19	"rentable_square_feet": 42,
20	"integration_id": "sample_value",
21	"integration_vendor": "sample_value",
22	"property_id": "sample_value",
23	"last_seen": "2024-07-01T00:00:00.000Z",
24	"x_location_id": "sample_value",
25	"x_building_id": "sample_value",
26	"x_floor_plan_id": "sample_value",
27	"building_number": "sample_value",
28	"make_ready_date": "2024-07-01T00:00:00.000Z",
29	"made_ready_date": "2024-07-01T00:00:00.000Z",
30	"reserved_until_date": "2024-07-01T00:00:00.000Z",
31	"floor_plan_market_rent_in_cents": 1.1,
32	"unit_market_rent_in_cents": 1.1,
33	"base_rent_in_cents": 1.1,
34	"unit_number": "sample_value",
35	"description": "sample_value",
36	"floor_plan_name": "sample_value",
37	"accessible_hearing": true,
38	"accessible_mobility": true,
39	"accessible_vision": true,
40	"is_vacant": true,
41	"is_available": true,
42	"is_reserved": true,
43	"available_date": "2024-07-01T00:00:00.000Z",
44	"notes": "sample_value",
45	"city": "sample_value",
46	"country": "sample_value",
47	"state": "sample_value",
48	"address_1": "sample_value",
49	"address_2": "sample_value",
50	"zip": "sample_value",
51	"maximum_potential_lease_term": "sample_value",
52	"minimum_potential_lease_term": "sample_value"
53	}
54	]
55	}