List

GET

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

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

metaanyOptional

GET

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

200Retrieved

1 {
2   "data": [
3     {
4       "id": 1.1,
5       "name": "name",
6       "comparable_addresses": [
7         {
8           "id": "52907745-7672-470e-a803-a2f8feb52944",
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           "lat": 40.7128,
23           "lon": -74.006,
24           "building_name": "The Main Building",
25           "score": 12323456789
26         }
27       ],
28       "excluded_property_ids": [
29         "excluded_property_ids"
30       ],
31       "emails": [
32         "emails"
33       ],
34       "schedule": [
35         "schedule"
36       ],
37       "modified_on": "2024-01-15T09:30:00Z",
38       "created_on": "2024-01-15T09:30:00Z",
39       "is_organization_visible": true,
40       "tags": [
41         "tags"
42       ],
43       "view_preferences": [
44         {
45           "name": "the_grid",
46           "building_rows": [
47             "building_rows"
48           ],
49           "unit_rows": [
50             "unit_rows"
51           ]
52         }
53       ],
54       "subject": {
55         "id": "52907745-7672-470e-a803-a2f8feb52944",
56         "building_name_alias": [
57           "The Main Building",
58           "Main Building",
59           "Main"
60         ],
61         "street_address": "123 Main St",
62         "street_address_alias": [
63           "123 Main St",
64           "125, Main Street"
65         ],
66         "city": "San Francisco",
67         "state": "CA",
68         "zip_code": "94103",
69         "lat": 40.7128,
70         "lon": -74.006,
71         "building_name": "The Main Building",
72         "score": 12323456789
73       },
74       "user_id": "user_id",
75       "deleted_on": "2024-01-15T09:30:00Z",
76       "last_run_on": "2024-01-15T09:30:00Z",
77       "public_id": "public_id",
78       "feature_flags": [
79         "expense_benchmark"
80       ],
81       "property_edits": [
82         {
83           "report_id": 1.1,
84           "user_id": "user_id",
85           "property_id": "52907745-7672-470e-a803-a2f8feb52944"
86         }
87       ],
88       "building_amenities_highlights": [
89         "24_hour_maintenance"
90       ],
91       "unit_amenities_highlights": [
92         "air_conditioning"
93       ],
94       "metadata": {
95         "key": "value"
96       }
97     }
98   ],
99   "meta": {
100     "key": "value"
101   }
102 }

Built with

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

1	{
2	"data": [
3	{
4	"id": 1.1,
5	"name": "name",
6	"comparable_addresses": [
7	{
8	"id": "52907745-7672-470e-a803-a2f8feb52944",
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	"lat": 40.7128,
23	"lon": -74.006,
24	"building_name": "The Main Building",
25	"score": 12323456789
26	}
27	],
28	"excluded_property_ids": [
29	"excluded_property_ids"
30	],
31	"emails": [
32	"emails"
33	],
34	"schedule": [
35	"schedule"
36	],
37	"modified_on": "2024-01-15T09:30:00Z",
38	"created_on": "2024-01-15T09:30:00Z",
39	"is_organization_visible": true,
40	"tags": [
41	"tags"
42	],
43	"view_preferences": [
44	{
45	"name": "the_grid",
46	"building_rows": [
47	"building_rows"
48	],
49	"unit_rows": [
50	"unit_rows"
51	]
52	}
53	],
54	"subject": {
55	"id": "52907745-7672-470e-a803-a2f8feb52944",
56	"building_name_alias": [
57	"The Main Building",
58	"Main Building",
59	"Main"
60	],
61	"street_address": "123 Main St",
62	"street_address_alias": [
63	"123 Main St",
64	"125, Main Street"
65	],
66	"city": "San Francisco",
67	"state": "CA",
68	"zip_code": "94103",
69	"lat": 40.7128,
70	"lon": -74.006,
71	"building_name": "The Main Building",
72	"score": 12323456789
73	},
74	"user_id": "user_id",
75	"deleted_on": "2024-01-15T09:30:00Z",
76	"last_run_on": "2024-01-15T09:30:00Z",
77	"public_id": "public_id",
78	"feature_flags": [
79	"expense_benchmark"
80	],
81	"property_edits": [
82	{
83	"report_id": 1.1,
84	"user_id": "user_id",
85	"property_id": "52907745-7672-470e-a803-a2f8feb52944"
86	}
87	],
88	"building_amenities_highlights": [
89	"24_hour_maintenance"
90	],
91	"unit_amenities_highlights": [
92	"air_conditioning"
93	],
94	"metadata": {
95	"key": "value"
96	}
97	}
98	],
99	"meta": {
100	"key": "value"
101	}
102	}