Get all properties

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 property id

x_property_idstringOptional

Deprecated: Use x_id instead

location_idstringOptional

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

integration_idstringOptional

The Propexo integration id

integration_vendorenumOptional

The integration vendor for the property.

Response

This endpoint returns an object.

metaobject

resultslist of objects

Errors

1 curl https://api.propexo.com/v1/properties/ \ 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 "property_id": "sample_value", 15 "created_at": "2024-07-01T00:00:00.000Z", 16 "updated_at": "2024-07-01T00:00:00.000Z", 17 "x_id": "sample_value", 18 "x_property_id": "sample_value", 19 "associated_owner_ids": [ 20 "sample_value" 21 ], 22 "integration_id": "sample_value", 23 "integration_vendor": "sample_value", 24 "last_seen": "2024-07-01T00:00:00.000Z", 25 "x_created_at": "2024-07-01T00:00:00.000Z", 26 "x_building_id": "sample_value", 27 "building_number": "sample_value", 28 "city": "sample_value", 29 "country": "sample_value", 30 "county": "sample_value", 31 "is_active": true, 32 "manager_email": "name@example.com", 33 "manager_name": "Rachel Smith", 34 "manager_phone_1": "6175551234", 35 "manager_phone_1_type": "FAX", 36 "manager_phone_2": "6175551234", 37 "manager_phone_2_type": "MOBILE", 38 "name": "Estates at East Lake", 39 "notes": "A quaint colonial in a nice suburban neighborhood.", 40 "number_of_units": 100, 41 "square_feet": 42, 42 "state": "sample_value", 43 "address_1": "sample_value", 44 "address_2": "sample_value", 45 "type_raw": "multifam", 46 "type_normalized": "MULTI_FAMILY", 47 "website": "sample_value", 48 "year_built": 2004, 49 "zip": "sample_value", 50 "square_footage": 42, 51 "street_address_1": "sample_value", 52 "street_address_2": "sample_value", 53 "type": "sample_value" 54 } 55 ] 56 }

1	curl https://api.propexo.com/v1/properties/ \
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	"property_id": "sample_value",
15	"created_at": "2024-07-01T00:00:00.000Z",
16	"updated_at": "2024-07-01T00:00:00.000Z",
17	"x_id": "sample_value",
18	"x_property_id": "sample_value",
19	"associated_owner_ids": [
20	"sample_value"
21	],
22	"integration_id": "sample_value",
23	"integration_vendor": "sample_value",
24	"last_seen": "2024-07-01T00:00:00.000Z",
25	"x_created_at": "2024-07-01T00:00:00.000Z",
26	"x_building_id": "sample_value",
27	"building_number": "sample_value",
28	"city": "sample_value",
29	"country": "sample_value",
30	"county": "sample_value",
31	"is_active": true,
32	"manager_email": "name@example.com",
33	"manager_name": "Rachel Smith",
34	"manager_phone_1": "6175551234",
35	"manager_phone_1_type": "FAX",
36	"manager_phone_2": "6175551234",
37	"manager_phone_2_type": "MOBILE",
38	"name": "Estates at East Lake",
39	"notes": "A quaint colonial in a nice suburban neighborhood.",
40	"number_of_units": 100,
41	"square_feet": 42,
42	"state": "sample_value",
43	"address_1": "sample_value",
44	"address_2": "sample_value",
45	"type_raw": "multifam",
46	"type_normalized": "MULTI_FAMILY",
47	"website": "sample_value",
48	"year_built": 2004,
49	"zip": "sample_value",
50	"square_footage": 42,
51	"street_address_1": "sample_value",
52	"street_address_2": "sample_value",
53	"type": "sample_value"
54	}
55	]
56	}