FOformbricks
Tenant Settings

Get tenant settings

Changed on

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.

get/v1/tenants/{tenant_id}/settings

Request

  • Base URL
    http://localhost:8080
  • URL
    http://localhost:8080/v1/tenants/{tenant_id}/settings
  • Auth
    HTTP bearer

Path parameters

tenant_idstring required
Example:org-123

Tenant ID whose settings should be returned. Empty strings and NULL bytes are not allowed.

Response

Tenant settings

tenant_idstring required

Tenant ID the settings belong to

Example response

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

Changes