Sign in

v1

latestOpenAPI 3.0.1Vanta Terms of Service2026-07-26327517821.8 KB
Customer Trust

Get questionnaire export status

Retrieves the current status and result of a questionnaire export using the id received from either the createQuestionnaireExport endpoint or the v1.questionnaire.export-completed webhook payload.

This endpoint utilizes a dynamic response schema that changes based on the value of the status field:

  • pending: The export is currently in the queue or processing. Only base metadata is returned.
  • completed: The export finished successfully. The response expands to include completedAt and a downloadUrl. This pre-signed URL is valid for 24 hours; if it expires, simply call this endpoint again to retrieve a fresh, active link.
  • failed: The process encountered an error. The response expands to include failedAt and an errorMessage detailing the reason for failure.

Developers should first check the status string before attempting to access result-specific fields like downloadUrl or errorMessage.

get/customer-trust/questionnaires/exports/{id}

Path parameters

idstring required

The unique identifier of the export job, returned from the POST endpoint.

Response

The export status and, if completed, the download URL.

idstring required

Unique identifier for the export job.

status'pending' | 'completed' | 'failed' required

Processing status of the export.

  • "pending": Export is still being processed.
  • "completed": Export finished successfully. Download URL is available.
  • "failed": Export failed. See errorMessage for details.
format'original' | 'csv' required

The output format of the exported file.

requestedAtstring required

ISO 8601 timestamp indicating when the export was requested.

completedAtstring

ISO 8601 timestamp indicating when the export completed successfully. Only present when status is "completed".

downloadUrlstring

Pre-signed URL for downloading the exported file. Valid for 24 hours from the time of this response. Only present when status is "completed".

expiresAtstring

ISO 8601 timestamp indicating when the download URL expires. After this time, request a new export. Only present when status is "completed".

failedAtstring

ISO 8601 timestamp indicating when the export failed. Only present when status is "failed".

errorMessagestring

Human-readable description of why the export failed. Only present when status is "failed".

Example response

{
  "id": "507f1f77bcf86cd799439011",
  "status": "completed",
  "format": "original",
  "requestedAt": "2025-01-08T12:00:00.000Z",
  "completedAt": "2025-01-08T12:05:00.000Z",
  "downloadUrl": "https://storage.example.com/exports/questionnaire-export.xlsx?token=...",
  "expiresAt": "2025-01-09T12:00:00.000Z",
  "failedAt": "2025-01-08T12:03:00.000Z",
  "errorMessage": "The questionnaire contains unsupported question types."
}