enterprise.export.create
Creates an enterprise compliance export task for a user. Runs asynchronously — the call returns immediately with status EXPORT_STATUS_PENDING. Poll enterprise.export.detail until status is EXPORT_STATUS_COMPLETED, then call enterprise.export.downloadUrl to fetch the archive.
Authorizations
Body
- Option 1
- Option 2
Target user ID. Either user_id or email must be provided.
"123e4567-e89b-12d3-a456-426614174000"
Export scope. Determines what data is included in the archive.
ENTERPRISE_EXPORT_SCOPE_FULL, ENTERPRISE_EXPORT_SCOPE_TASKS, ENTERPRISE_EXPORT_SCOPE_TASKS_WITH_ATTACHMENTS, ENTERPRISE_EXPORT_SCOPE_CUSTOM_SESSION_IDS, ENTERPRISE_EXPORT_SCOPE_WEBDEV_PROJECT, ENTERPRISE_EXPORT_SCOPE_PROJECT Target user email. Either user_id or email must be provided.
"user@example.com"
Include soft-deleted data in the export.
Lower time bound (RFC3339). Only data created on or after this time is included.
Upper time bound (RFC3339). Only data created on or before this time is included.
Specific session IDs to export. Required when scope is ENTERPRISE_EXPORT_SCOPE_CUSTOM_SESSION_IDS.
Include attached files in the archive.
Reason for the export. Logged for compliance auditing — supply a meaningful value.
"compliance audit"
Limit the export to specific webdev project UIDs. Only used when scope is ENTERPRISE_EXPORT_SCOPE_WEBDEV_PROJECT. Leave empty to include all webdev projects.
Limit the export to specific project UIDs. Only used when scope is ENTERPRISE_EXPORT_SCOPE_PROJECT. Leave empty to include all projects.
Response
Export task created successfully.
Whether the request was successful.
true
Unique identifier for this API request, useful for debugging.
Unique identifier of the export task. Use this with enterprise.export.detail and enterprise.export.downloadUrl.
Initial status. Always EXPORT_STATUS_PENDING for a freshly created task.
EXPORT_STATUS_PENDING, EXPORT_STATUS_PROCESSING, EXPORT_STATUS_COMPLETED, EXPORT_STATUS_FAILED, EXPORT_STATUS_CANCELLED Task creation time (RFC3339).
Target user ID resolved from the request.
"123e4567-e89b-12d3-a456-426614174000"
Enterprise unique identifier.