close

Get Workflow Version

Get an immutable deployment version and its pinned workflow graph snapshot.

GET/api/v2/workflows/{id}/versions/{version}

Authorization

apiKey
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

Path Parameters

id*string

Unique workflow identifier.

Length1 <= length
version*integer

Numeric deployment version.

Range0 < value <= 2147483647

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/workflows/string/versions/3" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "id": "version_3",
    "version": 3,
    "name": "Escalation routing",
    "description": "Adds the priority escalation branch.",
    "isActive": true,
    "createdAt": "2026-06-12T10:30:00.000Z",
    "state": {
      "blocks": {},
      "edges": []
    }
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "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"
  }
}
GETList Workflow VersionsGETExport Workflow