Skip to main content
POST
Export report
Required scope by format: pdf: reports.export_pdf, technical: reports.export_technical

Authorizations

Authorization
string
header
required

Use Authorization: Bearer rk_live_....

Headers

Idempotency-Key
string
required

A unique value for each new request, such as a UUID. Send the same value to retry a request safely. The same key and payload replay the first response with Idempotency-Replayed: true.

Required string length: 1 - 160

Path Parameters

report_id
string
required
Required string length: 1 - 200

Body

application/json
format
enum<string>
required
Available options:
pdf,
dxf,
csv,
xlsx,
xml,
zip
revision_id
string
Maximum string length: 200
audience
enum<string>

Who the PDF is for. It picks the app's Deliver sheet set and names the file. PDF only.

Available options:
client,
insurer,
supplier,
crew
pdf_profile
enum<string>

Overrides the workspace PDF profile for this export. PDF only.

Available options:
client,
production,
custom
csv_layout
enum<string>

The estimate-ready CSV, with quantities grouped the way insurance estimates read them. CSV only.

Available options:
estimate

Response

Export artifacts created.

revision_id
string
required
exports
object[]
required