Skip to content

Init Export ​

Initialize a system data export job. Requires the SYSTEM_EXPORT feature flag and ADMIN permissions.

Parameters ​

name * are required parametersdata typedescription
body.type*stringThe type of data to export (e.g., forms, users, training)
body.filtersobjectOptional filters to apply to the exported data
body.formatstringOutput format (e.g., csv, json)

Return Value ​

The initialized export job record, including a download URL when the export is ready.

Examples ​

bash
curl -X PUT "https://app.wombat.software/api/{targetPath}/export" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer ..." \
  -d '{"type": "forms", "format": "csv"}'

ENDPOINTS

put/api/{targetPath}/export