v1

latestSwagger 2.0Apache 2.02026-07-1334102.9 MB
Users

Request User Account Export

Initiates an export of the user's account data. This endpoint triggers an email to OSF support requesting an export of the user's account data. Only the authenticated user can request their own account export.

Returns

Returns a 204 No Content response if the export request was successfully submitted.

Errors

If the request is unsuccessful, an errors key containing information about the failure will be returned. Refer to the list of error codes to understand why this request may have failed. Some common error cases:

  • 403 Forbidden: You do not have permission to request an export for this user.
  • 429 Too Many Requests: Export requests are throttled. You may need to wait before trying again.
post/users/{user_id}/settings/export/

Path parameters

user_idstring required

The unique identifier of the user requesting the export. Example: abc123

Request body

Example request

{
  "data": {
    "type": "user-account-export-form"
  }
}

Response

Export request successfully submitted. The user will receive confirmation once the export process is completed.