Get Workflow Deployment

Read the current deployment state of a workflow: whether a version is live, when it went live, the most recent deployment attempt with its readiness and failure payload, and whether the editable draft has since diverged from the live version. This is the only operation that publishes needsRedeployment.

GET/api/v2/workflows/{id}/deployment

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

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/3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36/deployment" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "id": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
    "isDeployed": true,
    "needsRedeployment": true,
    "deployedAt": "2026-06-12T10:30:00.000Z",
    "warnings": [],
    "activeDeployment": {
      "deploymentVersionId": "depver_01J8ZK3QW4M6X2R9T7B5C0V2",
      "version": 3,
      "deployedAt": "2026-06-12T10:30:00.000Z"
    },
    "latestDeploymentAttempt": {
      "id": "depop_01J8ZK3QW4M6X2R9T7B5C0V1",
      "deploymentVersionId": "depver_01J8ZK3QW4M6X2R9T7B5C0V2",
      "version": 3,
      "action": "deploy",
      "status": "active",
      "isCurrent": true,
      "readiness": {
        "webhooks": "ready",
        "schedules": "ready",
        "mcp": "not_applicable"
      },
      "requestedAt": "2026-06-12T10:29:58.000Z",
      "activatedAt": "2026-06-12T10:30:00.000Z",
      "error": null
    }
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "The request is invalid."
  }
}