List

GET

https://api.hellodata.ai/property_report/list

GET

/property_report/list

1 curl https://api.hellodata.ai/property_report/list \
2      -H "x-api-key: <apiKey>"

Try it

200Retrieved

1 {
2   "data": [
3     {
4       "id": 1.1,
5       "name": "string",
6       "subject": {
7         "id": "52907745-7672-470e-a803-a2f8feb52944",
8         "building_name": "The Main Building",
9         "building_name_alias": [
10           "The Main Building",
11           "Main Building",
12           "Main"
13         ],
14         "street_address": "123 Main St",
15         "street_address_alias": [
16           "123 Main St",
17           "125, Main Street"
18         ],
19         "city": "San Francisco",
20         "state": "CA",
21         "zip_code": "94103",
22         "id_alias": [
23           "52907745-7672-470e-a803-a2f8feb52944"
24         ],
25         "lat": 40.7,
26         "lon": -74,
27         "number_units": 314,
28         "year_built": 2020,
29         "number_stories": 60
30       },
31       "comparable_addresses": [
32         {
33           "id": "52907745-7672-470e-a803-a2f8feb52944",
34           "building_name": "The Main Building",
35           "building_name_alias": [
36             "The Main Building",
37             "Main Building",
38             "Main"
39           ],
40           "street_address": "123 Main St",
41           "street_address_alias": [
42             "123 Main St",
43             "125, Main Street"
44           ],
45           "city": "San Francisco",
46           "state": "CA",
47           "zip_code": "94103",
48           "id_alias": [
49             "52907745-7672-470e-a803-a2f8feb52944"
50           ],
51           "lat": 40.7,
52           "lon": -74,
53           "number_units": 314,
54           "year_built": 2020,
55           "number_stories": 60
56         }
57       ],
58       "excluded_property_ids": [
59         "string"
60       ],
61       "user_id": "string",
62       "modified_on": "2024-01-15T09:30:00Z",
63       "created_on": "2024-01-15T09:30:00Z",
64       "deleted_on": "2024-01-15T09:30:00Z",
65       "public_id": "string",
66       "is_organization_visible": true,
67       "tags": [
68         "string"
69       ],
70       "view_preferences": [
71         null
72       ],
73       "email_schedule": {
74         "id": 1.1,
75         "schedulable_id": 1.1,
76         "schedulable_type": "datasets",
77         "emails": [
78           "string"
79         ],
80         "cron_expression": "string",
81         "last_execution": "2024-01-15T09:30:00Z",
82         "next_execution": "2024-01-15T09:30:00Z",
83         "created_on": "2024-01-15T09:30:00Z",
84         "modified_on": "2024-01-15T09:30:00Z",
85         "deleted_on": "2024-01-15T09:30:00Z"
86       },
87       "emails": [
88         "string"
89       ],
90       "schedule": [
91         "Monday"
92       ],
93       "feature_flags": [
94         "hellodata"
95       ],
96       "property_edits": [
97         {
98           "report_id": 1.1,
99           "user_id": "string",
100           "property_id": "52907745-7672-470e-a803-a2f8feb52944",
101           "year_built": 2020,
102           "number_stories": 10,
103           "number_units": 100,
104           "building_amenities": [
105             "24_hour_maintenance"
106           ],
107           "unit_amenities": [
108             "air_conditioning"
109           ],
110           "building_name": "string",
111           "cats_monthly_rent": 50,
112           "cats_one_time_fee": 50,
113           "cats_deposit": 50,
114           "dogs_monthly_rent": 50,
115           "dogs_one_time_fee": 50,
116           "dogs_deposit": 50,
117           "admin_fee": 600,
118           "amenity_fee": 1.1,
119           "application_fee": 65,
120           "storage_fee": 50,
121           "parking_covered": 300,
122           "parking_garage": 319,
123           "parking_surface_lot": 100,
124           "street_address": "123 Main St",
125           "management_company": "The Bozzuto Group",
126           "building_website": "https://www.property.com",
127           "street_view_url": "https://www.property.com/image.jpg",
128           "is_student": false,
129           "is_senior": false,
130           "is_affordable": false,
131           "is_lease_up": false,
132           "fees": [
133             {
134               "label": "string",
135               "amount": 1.1,
136               "frequency": "string"
137             }
138           ]
139         }
140       ],
141       "access_users": [
142         {
143           "id": "string",
144           "given_name": "string",
145           "family_name": "string",
146           "picture": "string",
147           "email": "string",
148           "job_title": "Analyst / Data"
149         }
150       ],
151       "building_amenities_highlights": [
152         "24_hour_maintenance"
153       ],
154       "unit_amenities_highlights": [
155         "air_conditioning"
156       ],
157       "sections": [
158         "property_grid"
159       ],
160       "columns": [
161         "property_grid.similarity"
162       ],
163       "metadata": {},
164       "is_in_portfolio": true
165     }
166   ]
167 }

List property report subscriptions that belong to the current user, or all reports for the organization.

Authentication

x-api-keystring

API Key authentication via header

Query parameters

adminbooleanOptional

Set this to true to get all reports that belong to the organization, and not just the ones for the current user

Response

datalist of objects

metaany or null