Listings

Get a listing by ID

GET
Get a listing by ID

Path parameters

listing_idstringRequired

Query parameters

order-bystringOptional
offsetintegerOptional
limitintegerOptional

Response

This endpoint returns an object
meta
object
results
object
GET
1curl https://api.propexo.com/v1/listings/listing_id \
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 "id": "clwktsp9v000008l31iv218hn",
13 "created_at": "2024-03-21T15:38:08.337Z",
14 "updated_at": "2024-03-22T10:59:45.119Z",
15 "x_id": "sample_value",
16 "x_property_id": "sample_value",
17 "is_unit": true,
18 "property_id": "clwi5xiix000008l6ctdgafyh",
19 "integration_id": "clwh5u07w000508me66sfh3um",
20 "integration_vendor": "(PMS ENUM VALUE)",
21 "last_seen": "2024-03-22T10:59:45.119Z",
22 "x_unit_id": "sample_value",
23 "available_date": "sample_value",
24 "application_url": "sample_value",
25 "bathrooms": "sample_value",
26 "bedrooms": "sample_value",
27 "building_name": "sample_value",
28 "building_number": "null",
29 "city": "Boston",
30 "country": "US",
31 "deposit_amount_in_cents": 1.1,
32 "floor_plan_code": "null",
33 "floor_plan_name": "null",
34 "floor": "null",
35 "image_urls": [
36 "image_urls"
37 ],
38 "is_available": true,
39 "is_furnished": true,
40 "is_listed": true,
41 "is_managed_external": true,
42 "is_vacant": true,
43 "lease_term": "null",
44 "listing_title": "null",
45 "listing_date": "sample_value",
46 "marketing_name": "null",
47 "notes": "null",
48 "number": "sample_value",
49 "rent_amount_in_cents": 1.1,
50 "specials": "null",
51 "square_feet": 1,
52 "state": "MA",
53 "street_address_1": "sample_value",
54 "street_address_2": "sample_value",
55 "address_1": "123 Main St",
56 "address_2": "address_2",
57 "property_description": "null",
58 "short_description": "null",
59 "unit_description": "sample_value",
60 "zip": "02116",
61 "make_ready_date": "null",
62 "vacate_date": "null",
63 "video_urls": [
64 "video_urls"
65 ],
66 "unit_id": "sample_value"
67 }
68}