For AI agents: the docs index is at https://docs.aurorasolar.com/llms.txt. Append .md to any documentation page URL to get its markdown version.
Jump to Content
Home
Tutorials
API Reference
Changelog
v2018.01
v2022.09
v2024.05
Log In
API Reference
Log In
v2024.05
Home
Tutorials
API Reference
Changelog
Versioning
introduction
Aurora Solar API
Environments
Authentication
HTTP Response Codes
Rate Limits
Credits
Versioning
Trying the API
Key Terms
Common Workflows
Entity Hierarchy
Feature Availability
Managing Pricing Outside of Aurora
Sync API
Tenants
Retrieve Tenant
get
Versions
Retrieve Versions
get
Upgrade Version
post
Rollback Version
post
Users
List Users
get
Create User
post
Invite User
post
Retrieve User
get
Update User
put
Activate User
put
Deactivate User
put
List Roles
get
Retrieve SSO Provider
get
Create SSO Provider
post
Update SSO Provider
put
Teams
List Teams
get
Partners
List Partners
get
Create Partner
post
Retrieve Partner
get
Update Partner
put
Partner Users
Add Users to Partner
post
Update Partner Users
put
Partner Logo
Upload Partner Logo
post
Orders
Retrieve Order
get
Update Order
put
Decline Order
post
Convert Order to Project
post
Retrieve Convert Order to Project Status
get
List Orders
get
Mark Order Sold
post
Projects
List Projects
get
Create Project
post
Retrieve Project
get
Update Project
put
Delete Project
del
List Project Assets
get
Create Project Asset
post
Retrieve AHJ
get
Project Notes
Create Project Note
post
Retrieve Project Note
get
Update Project Note
put
Retrieve Project Note Files
get
Consumption Profiles
Retrieve Consumption Profile
get
Update Consumption Profile
put
Utility Bills
Run Utility Bill Upload
post
Retrieve Utility Bill Upload Status
get
List Utility Bills
get
Retrieve Utility Bill
get
Bill Summaries
Retrieve Project Bill Summary
get
Retrieve Design Bill Summary
get
Design Requests
List Design Requests
get
Create Design Request
post
Retrieve Design Request
get
Accept Design Request
post
Designs
List Designs
get
Create Design
post
Duplicate Design
post
Retrieve Design
get
Update Design
put
Retrieve Design Summary
get
Retrieve Roof Summary
get
List Racking Arrays
get
Update Racking Bill of Materials
put
Retrieve Web Proposal
get
Generate Web Proposal URL
post
Run Proposal PDF Generation
post
Retrieve Proposal PDF Generation
get
Retrieve System Loss Settings
get
Update System Loss Settings
put
Design Assets
List Design Assets
get
Create Design Asset
post
Retrieve Design Asset
get
CAD Screenshot
Run CAD Screenshot
post
Retrieve CAD Screenshot Status
get
AI Roof
Run AI Roof
post
Retrieve AI Roof Status
get
Reject AI Roof
post
LIDAR Status
Retrieve LIDAR Status
get
Components
List Modules
get
Retrieve Module
get
List Inverters
get
Retrieve Inverter
get
List DC Optimizers
get
Retrieve DC Optimizer
get
Pricing
Retrieve Design Pricing
get
Update Design Pricing
put
Create Adder
post
Delete Adder
del
Create Incentive
post
Delete Incentive
del
Financings
List Financings
get
Retrieve Financing
get
Push Financing to Financier
post
Proposals
List Proposal Templates
get
Retrieve Proposal Template
get
Retrieve Proposal
get
Create Proposal
post
Delete Proposal
del
Agreements
List Agreements
get
Retrieve Agreement
get
Retrieve Agreement Link
get
Run Agreement Download URL Generation
post
Retrieve Agreement Download URL
get
Site Surveys
List Site Surveys
get
Create Site Survey
post
Retrieve Site Survey Request
get
Retrieve Site Survey
get
Update Site Survey Overview
put
Update Site Survey Electrical Data
put
Update Site Survey Electrical Subpanels
put
Update Site Survey Mounting Planes
put
Update Site Survey Status
put
Plan Sets
Create Plan Set Request
post
Retrieve Plan Set Request
get
Retrieve Plan Set
get
Webhooks
Create Webhook
post
List Webhooks
get
Retrieve Webhook
get
Update Webhook
put
Delete Webhook
del
Shared Projects
List Shared Projects
get
Milestones
Share Milestone
post
Design API
Fire Pathway Placement
Run Fire Pathway Placement
post
Retrieve Fire Pathway Placement Status
get
AutoDesigner
Run AutoDesigner
post
Retrieve AutoDesigner Status
get
Irradiance Analysis
Run Irradiance Analysis
post
Retrieve Irradiance Analysis Status
get
Performance Simulation
Run Performance Simulation
post
Retrieve Performance Simulation Status
get
appendix
Events
Asynchronous Endpoints
Project-based Tags
Powered by
Copy Page
Versioning
Updated about 1 year ago
Credits
Trying the API
Did this page help you?
Yes
No
Updated about 1 year ago
Credits
Trying the API
Did this page help you?
Yes
No
