GET
/api/v1/workflowsAuthorization
apiKey X-API-Key<token>
Your Sim API key (personal or workspace). Generate one from the Sim dashboard under Settings > API Keys.
In: header
Query Parameters
workspaceId*string
The unique identifier for your workspace. Found in the Sim dashboard URL or workspace settings.
folderId?string
Filter results to only include workflows within this folder.
deployedOnly?boolean
When true, only return workflows that have been deployed. Useful for listing workflows available for API execution.
limit?integer
Maximum number of workflows to return per page. Must be between 1 and 100.
Range
1 <= value <= 100cursor?string
Pagination cursor returned from a previous request's nextCursor field. Omit for the first page.
Response Body
application/json
application/json
application/json
application/json
curl -X GET \ "https://www.sim.ai/api/v1/workflows?workspaceId=YOUR_WORKSPACE_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",
"createdAt": "2025-01-10T09:00:00Z",
"updatedAt": "2025-06-18T16:45:00Z"
}
],
"nextCursor": "string",
"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",
"details": [
{}
]
}{
"error": "string"
}{
"error": "string"
}