RetailHardHat Developer docs

REST API documentation

Resource directory

Find supported REST endpoints and the field definitions used by the application.

Definitions below are drawn from the server's existing API metadata. Resources marked “field metadata only” do not have dedicated CRUD endpoints. Follow the listed operations rather than guessing URLs from resource names.

Sites

Physical site locations being developed or managed

36 documented fields

Tasks

Work items and action items assigned to team members

23 documented fields

Deals

Pre-construction pipeline deals for real estate acquisition

33 documented fields

Bids

Construction bids from contractors/vendors for site work

25 documented fields

Rfps

Requests for proposals sent to vendors for site work

19 documented fields

Permits

Permits and licenses required for site development

14 documented fields

Vendors

Vendor/contractor companies that provide services

15 documented fields

Invoices

Invoices associated with bids for tracking payments

18 documented fields

Phases

Project phases for organizing sites and tasks

11 documented fields

Rfis

Requests for information during construction

34 documented fields

Bid Contacts

Contacts associated with specific bids

11 documented fields

Users

User accounts (read-only via API)

6 documented fields

Change Requests

Change requests for scope/cost/schedule modifications on a site

21 documented fields

Task Assignees

User assignments to tasks (many-to-many)

4 documented fields

Task Teams

Team assignments to tasks

4 documented fields

Task Dependencies

Predecessor/successor relationships between tasks

9 documented fields

Task Comments

Comments and discussion threads on tasks

9 documented fields

Milestones

Key project milestones for tracking progress

11 documented fields

Site Notes

Notes and annotations on sites

8 documented fields

Site Documents

Documents uploaded and attached to sites

14 documented fields

Document Folders

Folder structure for organizing site documents

13 documented fields

Site Team Members

Team member assignments to sites

6 documented fields

Bid Line Items

Individual cost line items within a bid

12 documented fields

Bid Milestones

Payment milestones and schedule within a bid

9 documented fields

Bid Comparisons

AI-generated bid comparison analyses for an RFP

8 documented fields

Rfp Vendors

Vendors invited to respond to an RFP

9 documented fields

Rfp Notes

Internal notes on RFPs

8 documented fields

Rfp Documents

Documents attached to RFPs (bid packages, specs)

11 documented fields

Permit Payments

Fee payments associated with permits

12 documented fields

Permit Documents

Documents attached to permits

10 documented fields

Permit Blockers

Blocking issues preventing permit approval

8 documented fields

Permit Notes

Notes on permit applications and status

8 documented fields

Change Request Approvals

Approval workflow steps for change requests

9 documented fields

Change Request Documents

Supporting documents for change requests

10 documented fields

Change Request Line Items

Cost breakdown line items in change requests

12 documented fields

Deal History

Audit trail of changes to deals

11 documented fields

Deal Stages

Custom deal pipeline stage definitions

12 documented fields

Deal Budgets

Budget plans associated with deals

31 documented fields

Deal Budget Line Items

Individual line items within deal budgets

23 documented fields

Deal Budget Line Item Expenses

Actual expense entries against budget line items

16 documented fields

Budget Categories

Reusable categories for organizing budget line items

8 documented fields

Spend Forecasts

Financial spend forecasts for deals

38 documented fields

Spend Forecast Periods

Time-period breakdowns within spend forecasts

28 documented fields

Proformas

Pro forma financial models for deals/sites

81 documented fields

Proforma Sources

Sources of funds in pro formas

15 documented fields

Proforma Uses

Uses of funds in pro formas

11 documented fields

Proforma Cash Flows

Cash flow projections in pro formas

35 documented fields

Proforma Scenarios

What-if scenarios for pro forma analysis

11 documented fields

Risk Factors

Risk assessment factor definitions

13 documented fields

Deal Risk Assessments

Individual risk factor assessments for deals

13 documented fields

Deal Risk Summary

Aggregated risk scores for deals

19 documented fields

Vendor Workers

Individual workers/employees of vendor companies

13 documented fields

Site Vendors

Vendor assignments to specific sites

5 documented fields

Site Daily Logs

Daily field reports/logs for construction sites

12 documented fields

Site Daily Log Media

Photos and media attached to daily logs

10 documented fields

Criteria Profiles

Investment criteria profiles for deal matching

75 documented fields

Deal Criteria Matches

Matching scores between deals and criteria profiles

16 documented fields

Deal Distributions

Deal distribution/marketing campaigns

27 documented fields

Deal Distribution Recipients

Recipients of deal distribution campaigns

31 documented fields

Deal Distribution Packages

Document packages included in deal distributions

13 documented fields

Enterprise Leads

Inbound enterprise sales leads

20 documented fields

Due Diligence Tabs

Custom due diligence tab definitions

7 documented fields

Due Diligence Fields

Custom field definitions within due diligence tabs

12 documented fields

Due Diligence Field Values

Field values entered for due diligence on deals

7 documented fields

Asi Responses

Architect's supplemental instruction responses to RFIs

23 documented fields

Rfi Attachments

File attachments on RFIs

11 documented fields

Rfi Comments

Comments and discussion on RFIs

10 documented fields

Approval Flows

Approval workflow definitions

7 documented fields

Approval Flow Steps

Steps within approval workflows

7 documented fields

Approval Requests

Individual approval requests submitted for review

11 documented fields

Approval Request Actions

Approve/reject actions taken on approval requests

7 documented fields

Line Item Rfp Links

Links between budget line items and RFPs

4 documented fields

Line Item Bid Links

Links between budget line items and bids

4 documented fields

Projects

General projects for tracking cross-site work (events, marketing, technology, operations, partnerships)

14 documented fields

Project Tasks

Tasks belonging to a project (accessed via /api/v1/projects/:id/tasks)

12 documented fields

Project Notes

Notes and comments attached to a project (accessed via /api/v1/projects/:id/notes)

8 documented fields

Project Documents

Documents attached to a project (accessed via /api/v1/projects/:id/documents)

10 documented fields

Project Budget Items

Budget line items for a project (accessed via /api/v1/projects/:id/budget)

9 documented fields

Project Team Members

Team member assignments on a project (accessed via /api/v1/projects/:id/team)

5 documented fields