Get tenant settings

client.tenants.settings.retrieve(, ?): SettingRetrieveResponse { settings, tenant_id }

GET/v1/tenants/{tenant_id}/settings

Returns the enrichment settings for the specified tenant_id. A tenant that has not configured any settings yet returns HTTP 200 with default (unset) values rather than 404; consumers decide the fallback behavior for unset values. Settings are tenant-scoped and never shared across tenants.

ParametersExpand Collapse

tenantID: string

minLength1

maxLength255

ReturnsExpand Collapse

SettingRetrieveResponse { settings, tenant_id }

settings: Settings { target_language }

Tenant-scoped enrichment configuration. Fields are optional; absent fields use server defaults.

target_language?: string

Normalized BCP-47 locale (e.g. "en-US") that language enrichment translates feedback records and topic labels into. Absent or empty means not configured.

maxLength35

tenant_id: string

Tenant ID the settings belong to

minLength1

maxLength255

Get tenant settings

import FormbricksHub from '@formbricks/hub';

const client = new FormbricksHub({
  apiKey: process.env['HUB_API_KEY'], // This is the default and can be omitted
});

const setting = await client.tenants.settings.retrieve('org-123');

console.log(setting.tenant_id);

{
  "tenant_id": "org-123",
  "settings": {
    "target_language": "en-US"
  }
}

Returns Examples

{
  "tenant_id": "org-123",
  "settings": {
    "target_language": "en-US"
  }
}