Get a workflow's hosted chat and visitor access settings. Requires workspace admin access; a missing chat returns 404. Passwords are never returned; hasPassword indicates whether one is set. Hosted chat and workflow API deployment are managed separately. Workspace API keys return 403; use a personal API key or scoped OAuth token.
OAuth scope: api:read.
GET
/api/v2/workflows/{workflowId}/deployments/chatX-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.
Length
1 <= lengthResponse 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/deployments/chat" \ -H "X-API-Key: YOUR_API_KEY"{
"data": {
"id": "chat_01J8ZK3QW4M6X2R9T7B5C0V2",
"workflowId": "3b1f7c92-8d4e-4a6b-9c0d-5e2f8a714b36",
"workspaceId": "9f4c2a10-3b7e-4d58-8f6a-2c1d0e5b7a94",
"identifier": "support",
"url": "https://sim.ai/chat/support",
"title": "Support chat",
"description": "Ask about billing, onboarding, or outages.",
"isActive": true,
"authType": "public",
"hasPassword": false,
"allowedEmails": [],
"customizations": {
"primaryColor": "#6F3DFA",
"welcomeMessage": "Hi there! How can I help?"
},
"outputConfigs": [
{
"blockId": "block_01J8ZK3QW4M6X2R9T7B5C0V4",
"path": "content"
}
],
"includeThinking": false,
"includeToolCalls": false,
"createdAt": "2026-06-12T10:30:00.000Z",
"updatedAt": "2026-06-12T10:30:00.000Z"
}
}{
"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"
}
}