API Reference

Retrieve Proposal PDF Generation

get
https://api-sandbox.aurorasolar.com/tenants//designs//proposal_pdf_generation/status

Retrieve a proposal pdf generation job on a design.

You will need the job_id from the response body of a POST to the Run Proposal PDF Generation endpoint, or from the parameters of a proposal_pdf_generation_job_completed webhook call. Note that the webhook fires for both jobs initiated from the API and from the UI.

Path Params
uuid
required

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

uuid
required

The ID of the design that the proposal pdf was generated from.

Query Params
string
required

The ID of the proposal pdf generation job.

Responses

Updated 4 days ago

Language
Credentials
Bearer
header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 4 days ago