Get Workflow Deployment

Read live status, deployment time, latest attempt readiness and failure, draft divergence (needsRedeployment), anonymous execution access (isPublicApi), and registered webhook URLs. This read exposes public API access and webhook URLs; see their field descriptions for security and delivery details.

/workflows/{workflowId}/deployment controls overall API executability; /deployments/chat controls only the hosted-chat surface. A workflow can remain deployed without a chat.

OAuth scope: api:read.

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

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

Path Parameters

workflowId*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,
    "isPublicApi": false,
    "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
    },
    "webhooks": [
      {
        "blockId": "blk_01J8ZK3QW4M6X2R9T7B5C0V3",
        "provider": "generic",
        "url": "https://www.sim.ai/api/webhooks/trigger/leads"
      }
    ]
  }
}
{
  "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": "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"
  }
}
POSTImport WorkflowPATCHUpdate Workflow Public API Access