For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
LoginGet a Demo
DocumentationAPI Reference
DocumentationAPI Reference
  • Property Report
    • GETList
    • GETSearch
    • GETSearch Tags
    • GETReports By Tag
    • PATCHUpdate Metadata
  • Property
    • GETSearch
    • GETGet Property
    • POSTComparables
    • POSTPost Property
    • POSTMarket Rents
    • POSTExpense Benchmarks
  • Market
    • POSTMarket Search
    • GETShape Search
  • Dataset
    • POSTDataset Export Async
LogoLogo
LoginGet a Demo
Property Report

List

GET
https://api.hellodata.ai/property_report/list
GET
/property_report/list
$curl https://api.hellodata.ai/property_report/list \
>     -H "x-api-key: <apiKey>" \
>     -H "Content-Type: application/json"
200Retrieved
1{
2  "data": [
3    {
4      "id": 1024.5,
5      "name": "Downtown Office Portfolio Report",
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.7128,
26        "lon": -74.006,
27        "number_units": 314,
28        "year_built": 2020,
29        "number_stories": 60,
30        "created_on": "2023-11-01"
31      },
32      "comparable_addresses": [
33        {
34          "id": "52907745-7672-470e-a803-a2f8feb52944",
35          "building_name": "The Main Building",
36          "building_name_alias": [
37            "The Main Building",
38            "Main Building",
39            "Main"
40          ],
41          "street_address": "123 Main St",
42          "street_address_alias": [
43            "123 Main St",
44            "125, Main Street"
45          ],
46          "city": "San Francisco",
47          "state": "CA",
48          "zip_code": "94103",
49          "id_alias": [
50            "52907745-7672-470e-a803-a2f8feb52944"
51          ],
52          "lat": 40.7128,
53          "lon": -74.006,
54          "number_units": 314,
55          "year_built": 2020,
56          "number_stories": 60,
57          "created_on": "2023-11-01"
58        }
59      ],
60      "excluded_property_ids": [
61        "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
62      ],
63      "user_id": "user-7890-abcde-12345",
64      "modified_on": "2024-04-10T14:45:00Z",
65      "created_on": "2023-12-01T12:00:00Z",
66      "deleted_on": null,
67      "is_organization_visible": true,
68      "tags": [
69        "office",
70        "Q2-2024",
71        "executive"
72      ],
73      "view_preferences": [
74        {
75          "name": "the_grid",
76          "building_rows": [
77            "property_grid.address",
78            "property_grid.number_units",
79            "property_grid.year_built"
80          ],
81          "unit_rows": [
82            "unit_details.floorplan_name",
83            "unit_details.rent_psf"
84          ]
85        }
86      ],
87      "email_schedule": {
88        "emails": [
89          "reports@companydomain.com",
90          "manager@companydomain.com"
91        ],
92        "cron_expression": "0 9 1 * *",
93        "id": 2048.75,
94        "schedulable_id": 1024.5,
95        "schedulable_type": "property_reports",
96        "last_execution": "2024-04-01T09:00:00Z",
97        "next_execution": "2024-05-01T09:00:00Z",
98        "created_on": "2023-12-15T08:30:00Z",
99        "modified_on": "2024-03-01T10:00:00Z",
100        "deleted_on": null
101      },
102      "public_id": "public-5678-xyz",
103      "feature_flags": [
104        "make_organization_visible",
105        "member_external_sharing"
106      ],
107      "property_edits": [
108        {
109          "report_id": 1024.5,
110          "user_id": "user-7890-abcde-12345",
111          "property_id": "123e4567-e89b-12d3-a456-426614174000",
112          "year_built": 2018,
113          "number_stories": 12,
114          "number_units": 150,
115          "building_amenities": [
116            "24_hour_maintenance",
117            "fitness_center",
118            "parking_garage"
119          ],
120          "unit_amenities": [
121            "air_conditioning",
122            "dishwasher",
123            "hardwood_floor"
124          ],
125          "building_name": "Sunset Towers",
126          "cats_monthly_rent": 75,
127          "cats_one_time_fee": 150,
128          "cats_deposit": 200,
129          "dogs_monthly_rent": 100,
130          "dogs_one_time_fee": 200,
131          "dogs_deposit": 300,
132          "admin_fee": 500,
133          "amenity_fee": 50,
134          "application_fee": 75,
135          "storage_fee": 40,
136          "parking_covered": 250,
137          "parking_garage": 320,
138          "parking_surface_lot": 120,
139          "street_address": "456 Sunset Blvd",
140          "management_company": "Sunset Property Management",
141          "building_website": "https://www.sunsettowers.com",
142          "street_view_url": "https://www.sunsettowers.com/images/streetview.jpg",
143          "is_student": false,
144          "is_senior": false,
145          "is_build_to_rent": false,
146          "is_affordable": false,
147          "is_lease_up": false,
148          "is_condo": false,
149          "fees": [
150            {
151              "label": "Move-in Fee",
152              "amount": 300,
153              "frequency": "once"
154            },
155            {
156              "label": "Monthly Trash Fee",
157              "amount": 25,
158              "frequency": "month"
159            }
160          ]
161        }
162      ],
163      "access_users": [
164        {
165          "id": "user-1234-5678-9012",
166          "given_name": "Alice",
167          "family_name": "Johnson",
168          "picture": "https://companydomain.com/profiles/alicejohnson.jpg",
169          "email": "alice.johnson@companydomain.com",
170          "read_only": true,
171          "job_title": "Analyst / Data"
172        },
173        {
174          "id": "user-2345-6789-0123",
175          "given_name": "Bob",
176          "family_name": "Smith",
177          "picture": "https://companydomain.com/profiles/bobsmith.jpg",
178          "email": "bob.smith@companydomain.com",
179          "read_only": false,
180          "job_title": "Property Operations"
181        }
182      ],
183      "sections": [
184        "property_grid",
185        "amenities",
186        "financial_analysis"
187      ],
188      "columns": [
189        "property_grid.similarity",
190        "property_grid.year_built",
191        "amenities.market_rent",
192        "financial_analysis.avg_rent"
193      ],
194      "metadata": {
195        "region": "West Coast",
196        "priority": "high"
197      },
198      "is_in_portfolio": true,
199      "organization_visibility": "editor"
200    }
201  ]
202}
List property report subscriptions that belong to the current user, or all reports for the organization.
Was this page helpful?

Search

Next
Built with

Authentication

x-api-keystring
API Key authentication via header
OR
AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

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

Ok
datalist of objects
metaany