v1

latestOpenAPI 3.0.02026-07-241010520.6 KB

Designs

Retrieve Web Proposal

Retrieve Web Proposal for a design.

A Web Proposal is a customer facing proposal that can be given to homeowners to view proposals generated using Aurora Sales Mode. A Web Proposal is only accessible through a valid url which expires after a certain amount of time (To get more information on the Web Proposal expiration time, please contact your Aurora account team). A Web Proposal can only have a single non-expired url at a time. If a Web Proposal has not been created yet then the url will be "null" & expired will be "false".

get/tenants/{tenant_id}/designs/{design_id}/web_proposal

Path parameters

tenant_idstring uuid required

The ID of the tenant that the design is part of.

design_idstring uuid required

The ID of the design to retrieve web proposal for.

Response

Web proposal successfully retrieved.

Example response

{
  "web_proposal": {
    "url": "https://v2.aurorasolar.com/e-proposal/_df-JNW4uAez5a7KThnOaBhr8auE74Qw1-oYOzrS_SI"
  }
}