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}

Get questionnaire export status

cURL

curl --request GET \
  --url https://api.vanta.com/v1/customer-trust/questionnaires/exports/{id} \
  --header 'Authorization: Bearer <token>'

200

{
  "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=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9&expires=1736424000",
  "expiresAt": "2025-01-09T12:00:00.000Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

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

Response

200 - application/json

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

Detailed status and result of a questionnaire export. When status is "completed", the response includes a time-limited download URL.

id · string · required

Unique identifier for the export job.

Example:

"507f1f77bcf86cd799439011"

status · enum<string> · 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.

Available options: pending, completed, failed

Example:

"completed"

format · enum<string> · required

The output format of the exported file.

Available options: original, csv

Example:

"original"

requestedAt · string · required

ISO 8601 timestamp indicating when the export was requested.

Example:

"2025-01-08T12:00:00.000Z"

completedAt · string

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

Example:

"2025-01-08T12:05:00.000Z"

downloadUrl · string

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

Example:

"https://storage.example.com/exports/questionnaire-export.xlsx?token=..."

expiresAt · string

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

Example:

"2025-01-09T12:00:00.000Z"

failedAt · string

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

Example:

"2025-01-08T12:03:00.000Z"

errorMessage · string

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

Example:

"The questionnaire contains unsupported question types."