v1
latestOpenAPI 3.0.02026-07-241010520.6 KBDesigns
Retrieve Proposal PDF Generation
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.
get/tenants/{tenant_id}/designs/{design_id}/proposal_pdf_generation/status
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 that the proposal pdf was generated from.
Query parameters
job_idstring required
The ID of the proposal pdf generation job.
Response
Proposal PDF Generation job status successfully retrieved.
Example response
{
"proposal_pdf_generation_job": {
"status": "succeeded"
}
}