Get Workflow

Retrieve details for a single workflow, including its input fields and deployment status.

GET/api/v1/workflows/{id}

Authorization

apiKey
X-API-Key<token>

Your Sim API key (personal or workspace). Generate one from the Sim dashboard under Settings > API Keys.

In: header

Path Parameters

id*string

The unique workflow identifier.

Response Body

application/json

application/json

application/json

application/json

curl -X GET \  "https://www.sim.ai/api/v1/workflows/{id}" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "id": "wf_1a2b3c4d5e",
    "name": "Customer Support Agent",
    "description": "Routes incoming support tickets and drafts responses",
    "color": "#33c482",
    "folderId": "folder_abc123",
    "workspaceId": "ws_xyz789",
    "isDeployed": true,
    "deployedAt": "2025-06-15T10:30:00Z",
    "runCount": 142,
    "lastRunAt": "2025-06-20T14:15:22Z",
    "variables": {},
    "inputs": {
      "fields": {}
    },
    "createdAt": "2025-01-10T09:00:00Z",
    "updatedAt": "2025-06-18T16:45:00Z"
  },
  "limits": {
    "workflowExecutionRateLimit": {
      "sync": {
        "requestsPerMinute": 60,
        "maxBurst": 10,
        "remaining": 59,
        "resetAt": "2025-06-20T14:16:00Z"
      },
      "async": {
        "requestsPerMinute": 60,
        "maxBurst": 10,
        "remaining": 59,
        "resetAt": "2025-06-20T14:16:00Z"
      }
    },
    "usage": {
      "currentPeriodCost": 1.25,
      "limit": 50,
      "plan": "pro",
      "isExceeded": false
    }
  }
}
{
  "error": "string"
}
{
  "error": "string"
}
{
  "error": "string"
}