---
title: "Retrieve workspace settings"
method: GET
path: "/v2/workspace-settings"
tags: ["Workspace Settings"]
---

# Retrieve workspace settings

`GET /v2/workspace-settings`

Returns the current settings for the authenticated workspace: its read-only key/slug, display name, the enforce-enabled-models flag, and the workspace-default PII redaction plugin configuration.

## Response `200`

OK

- GetWorkspaceSettingsResponse
  - `settings` WorkspaceSettings, required — WorkspaceSettings is the full settings state returned by Get and Update.
    - `key` string, required — Read-only workspace key/slug. Returned for reference; it cannot be changed through this service.
    - `display_name` string, required — Human-readable workspace display name.
    - `enforce_enabled_models` boolean, required — Whether only workspace-enabled models may be served.
    - `pii_redaction` PiiRedaction — PiiRedaction is the workspace-default configuration for the pii_redaction plugin: an enable flag plus the optional plugin config the gateway applies as a floor for requests that send no plugins of their own.
      - `enabled` boolean, required — Whether the workspace-default PII redaction plugin is enabled.
      - `config` PiiRedactionConfig — PiiRedactionConfig mirrors the workspace-default PII redaction plugin config (libs/go/models PIIRedactionPlugin / libs/models/gateway PIIRedactionPluginSchema). Every field is optional; the gateway applies its own defaults for unset fields. The stored value is validated on write with the same models.PIIRedactionPlugin.Validate() the gateway runs per request. Without that, an invalid workspace default would 400 every gateway call for the workspace, since the default plugin is injected into each request and validated there.
        - `language` string — Detector language. One of "en" or "nl"; omit for the gateway default ("en"). The valid entity catalog depends on this value.
        - `entities` string[] — Entity types to redact (e.g. "EMAIL_ADDRESS", "PERSON"). Values are validated against the entity catalog for `language`; omit to redact every type the detector finds.
        - `on_failure` string — Behaviour when redaction cannot run: "block" (fail closed, the default) or "passthrough" (fail open, send the original text).
        - `threshold` number, double — Detection confidence threshold in the [0, 1] range.

---

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