Export workflow

Export the saved draft as portable workflow data with workspace read access. Registered credential fields and opaque table/tool values are cleared; environment references and ordinary workflow variables remain included. Review other configuration before sharing.

Default exports clear workspace bindings. Use includeWorkspaceBindings=true to retain non-secret bindings for a same-workspace import, or includeReferences=true for source identities and field occurrences used by mapped imports. Exporting records an audit event. HEAD checks access with the same authorization as GET but skips side effects, returning an empty 200 without payload headers on success. Workspace folder trees exceeding 10,000 folders return 413.

OAuth scope: api:read.

GET/api/v2/workflows/{workflowId}/export

Authorization

X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Request examples use an API key. For OAuth, replace the X-API-Key header with Authorization: Bearer YOUR_ACCESS_TOKEN.

curl -X GET "https://www.sim.ai/api/v2/workflows/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/export" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "version": "1.0",
    "exportedAt": "2026-08-09T18:04:11.000Z",
    "workflow": {
      "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
      "name": "Customer support triage",
      "description": "Routes incoming support requests to the right team.",
      "workspaceId": "a91c4b2e-6d3f-4e8a-b5c7-0d9e2f1a8c64",
      "folderPath": "/Operations"
    },
    "state": {
      "blocks": {},
      "edges": []
    }
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "PAYLOAD_TOO_LARGE",
    "message": "Request body is too large"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}

Path parameters

workflowId*string

Unique workflow identifier.

Length1 <= length

Query parameters

includeReferences?boolean

Include non-secret resource identifiers and source field occurrences for mapped imports.

includeWorkspaceBindings?boolean

Keep non-secret table, knowledge base, document, folder, channel, and other workspace bindings for a same-workspace import. Defaults to false, which clears these IDs. Registered credential fields and opaque table/tool values are cleared either way; environment references and ordinary workflow variables remain included.

Response body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

POSTRevert workflow to versionPOSTImport workflow