---
title: "get settings (admin only)"
method: GET
path: "/w/{workspace}/workspaces/get_settings"
tags: ["workspace"]
---

# get settings (admin only)

`GET /w/{workspace}/workspaces/get_settings`

Returns the full workspace settings including admin-managed integration credentials. Admin-only — non-admin callers should use `getPublicSettings`.

## Path parameters

- `workspace` string, required

## Response `200`

status

- object
  - `workspace_id` string
  - `slack_name` string
  - `slack_team_id` string
  - `slack_command_script` string
  - `slack_oauth_client_id` string
  - `slack_oauth_client_secret` string
  - `teams_team_id` string
  - `teams_command_script` string
  - `teams_team_name` string
  - `teams_team_guid` string
  - `auto_invite` AutoInviteConfig — Configuration for auto-inviting users to the workspace
    - `enabled` boolean
    - `domain` string
    - `operator` boolean — If true, auto-invited users are added as operators. If false, they are added as developers.
    - `mode` 'invite' | 'add'
    - `instance_groups` string[]
    - `instance_groups_roles` object
  - `plan` string
  - `customer_id` string
  - `webhook` string
  - `ai_config` AIConfig
    - `providers` object
    - `default_model` AIProviderModel
      - `model` string, required
      - `provider` 'openai' | 'azure_openai' | 'azure_foundry' | 'anthropic' | 'mistral' | 'deepseek' | 'googleai' | 'groq' | 'openrouter' | 'togetherai' | 'aws_bedrock' | 'customai', required
    - `metadata_model` AIProviderModel
      - `model` string, required
      - `provider` 'openai' | 'azure_openai' | 'azure_foundry' | 'anthropic' | 'mistral' | 'deepseek' | 'googleai' | 'groq' | 'openrouter' | 'togetherai' | 'aws_bedrock' | 'customai', required
    - `code_completion_model` AIProviderModel
      - `model` string, required
      - `provider` 'openai' | 'azure_openai' | 'azure_foundry' | 'anthropic' | 'mistral' | 'deepseek' | 'googleai' | 'groq' | 'openrouter' | 'togetherai' | 'aws_bedrock' | 'customai', required
    - `custom_prompts` object
    - `max_tokens_per_model` object
  - `error_handler` ErrorHandlerConfig — Configuration for the workspace error handler
    - `path` string — Path to the error handler script or flow
    - `extra_args` ScriptArgs — The arguments to pass to the script or flow
    - `muted_on_cancel` boolean
    - `muted_on_user_path` boolean
  - `success_handler` SuccessHandlerConfig — Configuration for the workspace success handler
    - `path` string — Path to the success handler script or flow
    - `extra_args` ScriptArgs — The arguments to pass to the script or flow
  - `large_file_storage` LargeFileStorage
    - `type` 'S3Storage' | 'AzureBlobStorage' | 'AzureWorkloadIdentity' | 'S3AwsOidc' | 'GoogleCloudStorage'
    - `s3_resource_path` string
    - `azure_blob_resource_path` string
    - `gcs_resource_path` string
    - `public_resource` boolean
    - `advanced_permissions` S3PermissionRule[]
      - `pattern` string, required
      - `allow` string, required
    - `secondary_storage` object
  - `ducklake` DucklakeSettings
    - `ducklakes` object, required
  - `dbt_warehouses` DbtWarehouses — Warehouses a dbt project may run against, by name. `main` is the one a project gets when its descriptor names none. Each entry points at a resource; it never holds credentials.
  - `datatable` DataTableSettings
    - `datatables` object, required
  - `git_sync` WorkspaceGitSyncSettings
    - `repositories` GitRepositorySettings[]
      - `script_path` string
      - `git_repo_resource_path` string, required
      - `use_individual_branch` boolean
      - `group_by_folder` boolean
      - `collapsed` boolean
      - `settings` object
        - `include_path` string[]
        - `include_type` GitSyncObjectType[]
        - `exclude_path` string[]
        - `extra_include_path` string[]
      - `exclude_types_override` GitSyncObjectType[]
      - `auto_pull` AutoPullSettings
        - `enabled` boolean, required
        - `mode` 'auto' | 'webhook' | 'polling'
        - `poll_interval_s` integer
        - `sync_forks` boolean
        - `webhook_id` integer
        - `webhook_secret` string
        - `webhook_url` string
        - `webhook_error` string
        - `last_synced_sha` object
        - `last_pull_status` AutoPullStatus
          - `synced_sha` string
          - `at` integer, required
          - `job_id` string, uuid
          - `success` boolean, required
          - `error` string
      - `promotion_open_prs` boolean
      - `fork_open_prs` boolean
      - `open_pr_error` string — server-owned, last failure opening a PR for a deploy branch of this repo
  - `deploy_ui` WorkspaceDeployUISettings
    - `include_path` string[]
    - `include_type` GitSyncObjectType[]
  - `default_app` string
  - `default_scripts` WorkspaceDefaultScripts
    - `order` string[]
    - `hidden` string[]
    - `default_script_content` unknown
  - `mute_critical_alerts` boolean
  - `color` string
  - `operator_settings` OperatorSettings, nullable
    - `runs` boolean, required — Whether operators can view runs
    - `schedules` boolean, required — Whether operators can view schedules
    - `resources` boolean, required — Whether operators can view resources
    - `variables` boolean, required — Whether operators can view variables
    - `assets` boolean, required — Whether operators can view assets
    - `audit_logs` boolean, required — Whether operators can view audit logs
    - `triggers` boolean, required — Whether operators can view triggers
    - `groups` boolean, required — Whether operators can view groups page
    - `folders` boolean, required — Whether operators can view folders page
    - `workers` boolean, required — Whether operators can view workers page
  - `public_app_execution_limit_per_minute` integer — Rate limit for public app executions per minute per server. NULL or 0 means disabled.
  - `error_handler_fallback_to_instance_alerts` boolean — Report failed jobs to the instance critical alert channels when no workspace error handler is set.

---

[API](https://skmtc.net/windmill/apis/windmill-api.md) · [All operations](https://skmtc.net/windmill/apis/windmill-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/windmill/windmill-api/versions/155a35b3caff/schema)