Skip to main content
Export some or all of a project’s sheets as a single PDF. It is the same report you get from Print in the app. This is an asynchronous flow:
  1. Start the export and receive an exportId.
  2. Poll until state is completed.
  3. Download the PDF from exportUrl.

Endpoints

Export Project to PDF · Get Export Status

Request body

All fields are optional. Without sheetIds, every sheet in the project is exported.

Selecting sheets

Every ID in sheetIds must belong to the project. If any well-formed ID does not, the request is rejected with 422 Unprocessable Entity, each offending ID is named, and no export starts:
A malformed request (empty sheetIds, a non-UUID, or an invalid printMode or paperSize) returns 400 Bad Request with the same envelope.

Response

Both endpoints return the same shape. exportUrl is null until state is completed:
state is processing, completed, or failed. exportUrl is null while processing or failed. Once completed, it is a presigned URL that expires 10 minutes after each poll. Every poll returns a fresh one.

Polling

Poll GET /v1/exports/{exportId} until state is completed or failed, with backoff rather than a tight loop. Small projects usually finish in a few seconds; large ones can take 30 seconds or more.

Notes

  • Formatting matches Print in the app, including project-level print preferences such as member schedules.
  • The export carries the organisation’s watermark, if it has one.
  • If state becomes failed, the export will not complete; start a new one. Common causes are an unsolved sheet or a temporary rendering failure.
  • Use the exportUrl from the latest poll; there is no need to cache it.