---
title: "Get Workspace Config"
method: GET
path: "/v1/{workspace}/config/"
---

# Get Workspace Config

`GET /v1/{workspace}/config/`

Retrieve workspace-level configuration flags — the settings that govern behavior for every user, tenant, and workflow inside this workspace.

Fields returned:
- `user_inbox_preference_enabled` — if you are using the Inbox channel, enable this to show the Inbox channel in the preference centre.
- `sms_vendor_type` — SMS delivery mode used for this workspace (`basic` for standard sends, `dlt` for India DLT-compliant sends).
- `user_tenancy_mode` — how a user's association to tenants is constrained. `shared` allows a user to belong to any number of tenants; `exclusive` restricts each user to at most one tenant. See [User-tenant mapping](/docs/user-tenant-mapping) for the trade-offs.
- `user_tenancy_channel_fallback_mode` and `user_tenancy_channel_fallback` — govern which channels on a tenant-scoped profile are allowed to fall back to the user's global profile. Use `allowlist` mode with an explicit list to prevent identities like `$androidpush` or `$slack` from leaking across tenants.
- `user_tenancy_channel_fallback_applies_to_default_tenant` — whether the fallback rule above also applies to the default-tenant path (sends without a `tenant_id`).

## Path parameters

- `workspace` string, required

## Response `200`

Workspace config retrieved.

- WorkspaceConfig — Workspace-level configuration flags.
  - `user_inbox_preference_enabled` boolean — If you are using the Inbox channel, enable this to show the Inbox channel in the preference centre.
  - `sms_vendor_type` 'basic' | 'dlt' — SMS delivery mode for the workspace. Use `dlt` for India DLT-compliant sends; `basic` for standard sends.
  - `user_tenancy_mode` 'shared' | 'exclusive' — Constraint on user-tenant associations for this workspace. - `shared` — a user can belong to any number of tenants. - `exclusive` — a user can belong to at most one tenant. The associate call rejects users that already have a mapping. New workspaces default to `exclusive`; workspaces that existed before this setting was introduced default to `shared`.
  - `user_tenancy_channel_fallback_mode` 'all' | 'allowlist' — Controls which channels a tenant-scoped profile is allowed to inherit from the user's global profile when the tenant has no override for that channel. - `all` — every channel falls back to global (default; reproduces a straight shallow merge). - `allowlist` — only the channels listed in `user_tenancy_channel_fallback` fall back; every other channel is dropped from the send when the tenant has no override for it. Prevents identities like `$androidpush` or `$slack` from leaking across tenants.
  - `user_tenancy_channel_fallback` string[] — Channel keys allowed to fall back from the global profile when `user_tenancy_channel_fallback_mode = allowlist`. Ignored when the mode is `all`. Typical setup: `["$email", "$sms", "$whatsapp"]` — safe to fall back — while excluding `$androidpush`, `$iospush`, `$webpush`, `$inbox`, and `$slack`.
  - `user_tenancy_channel_fallback_applies_to_default_tenant` boolean — Whether the fallback rule above also governs sends that carry no `tenant_id` (the default-tenant path). - `false` (default) — the default-tenant path always falls back for every channel, regardless of the allowlist. - `true` — the default-tenant path follows the same `user_tenancy_channel_fallback_mode` + `user_tenancy_channel_fallback` rule as other tenants.

## Other responses

- `401` — Authentication failed
- `404` — Resource not found

---

[API](https://skmtc.net/suprsend/apis/suprsend-api.md) · [All operations](https://skmtc.net/suprsend/apis/suprsend-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/suprsend/suprsend-api/revisions/8bd2574bd2c3/schema)