List Chat Deployments

List hosted chats and their public URLs with cursor pagination. Filter by workflowId for one workflow's chat. The list requires workspace read access; Get Workflow Chat Deployment requires admin access and includes visitor access settings and customizations. Passwords are never returned.

OAuth scope: api:read.

GET/api/v2/chat-deployments

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

Query Parameters

workspaceId*string

Workspace whose chat deployments to list.

Length1 <= length <= 128
workflowId?string

Restrict to deployments of one workflow.

Length1 <= length
isActive?boolean

Restrict to active or inactive deployments.

sortBy?string

Field used to sort the result.

Default"createdAt"
Value in"identifier" | "createdAt" | "updatedAt"
sortOrder?string

Sort direction.

Default"desc"
Value in"asc" | "desc"
limit?integer

Maximum chat deployments to return per page. Must be a whole number from 1 to 100. Defaults to 50.

Default50
Range1 <= value <= 100
cursor?string

Opaque cursor from the previous page. Send it back with the same sort and filters; only limit may change. Change anything else and pagination must restart without a cursor.

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/chat-deployments?workspaceId=string" \  -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",
      "outputConfigs": [
        {
          "blockId": "block_01J8ZK3QW4M6X2R9T7B5C0V4",
          "path": "content"
        }
      ],
      "includeThinking": false,
      "includeToolCalls": false,
      "createdAt": "2026-06-12T10:30:00.000Z",
      "updatedAt": "2026-06-12T10:30:00.000Z"
    }
  ],
  "nextCursor": null
}
{
  "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"
  }
}
POSTRollback WorkflowGETGet Workflow Chat Deployment