Export current-user data

OpenAPI contract

Method

GET

Path

/api/v1/user/me/export

Security

jwtBearer (bearer)

Response status

200 400 401 403 429 500

Request and response schemas

JSON

{
  "requestBody": {},
  "responses": {
    "200": {
      "description": "Account data archive",
      "content": {
        "application/zip": {
          "format": "binary",
          "type": "string"
        }
      }
    },
    "400": {
      "description": "Invalid request",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/RequestError"
        }
      }
    },
    "401": {
      "description": "Authentication required or invalid",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "403": {
      "description": "Authenticated but not permitted",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "429": {
      "description": "Rate limit exceeded",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/SecurityError"
        }
      }
    },
    "500": {
      "description": "Unexpected server error",
      "content": {
        "application/json": {
          "$ref": "#/components/schemas/ApiError"
        }
      }
    }
  }
}

GET /api/v1/user/me/export is JWT-only. The optional workspaceName query parameter selects the name used in the export; without it, the current profile workspace is used. The successful response is a ZIP download with a Content-Disposition filename and a workspace.json snapshot.

The archive includes profile data, projects, processor presets, and compile-task history, which can contain filenames, messages, configuration, and account information. An nfy_ automation key cannot export this data; store the ZIP securely and do not expose its URL or contents.

http

GET /api/v1/user/me/export?workspaceName=example
Authorization: Bearer <access token>