POST Questionnaire Exports

Request an export of a filled questionnaire.

post/v2/questionnaires/{id}/exports

Path parameters

idstring uuid required

UUID of the questionnaire to export.

Request body

export_type'csv' | 'original' | 'summary' required

Type of export. "csv" returns immediately. "original" repopulates the source document. "summary" creates a new summary document. If the original document is Excel-based, "summary" and "original" will both return XLSX.

Response

Questionnaire export request.

idstring required

UUID of the export.

questionnaire_idstring required

UUID of the questionnaire.

status'pending' | 'completed' required

Export status. CSV exports return completed immediately.

export_type'csv' | 'original' | 'summary' required

Type of export.

download_urlstring nullable

Signed download URL with 7-day expiry. Null when pending.

created_atstring date-time required

ISO 8601 datetime when the export was created.

completed_atstring date-time nullable

ISO 8601 datetime when the export finished. Null when pending.

Changes

No recorded changes to this endpoint across all 1 revision of this API.