Get Workspace Settings

Return branding, support, policy, analytics, localization, and tax settings for a workspace.

Method

GET /v1/workspaces/:id/settings

Path Parameters

id · uuid · required

Workspace identifier (must match API key workspace).

Headers

Authorization · string

Bearer token with workspaces:read scope.

Request Example

cURL

curl "https://api.voyantcloud.com/v1/workspaces/ws_abc/settings" \
  -H "Authorization: Bearer $VOYANT_API_KEY"

Response

200 OK

{
  "data": {
    "branding": {
      "logo_light_asset_id": "asset_light",
      "logo_dark_asset_id": "asset_dark",
      "favicon_asset_id": "asset_favicon"
    },
    "support": {
      "phone": "[phone]",
      "email": "[e-mail]"
    },
    "policies": {
      "terms_url": "https://example.com/terms",
      "privacy_url": "https://example.com/privacy"
    },
    "analytics": {
      "gtm_id": "GTM-XXXXXXX"
    },
    "localization": {
      "default_catalog_language": "en",
      "default_ui_language": "en",
      "supported_languages": ["en", "ro"]
    },
    "taxes": {
      "prices_include_tax": false,
      "enable_unified_taxes": true,
      "enable_vat_validation": true,
      "default_tax_profile_id": "taxprof_123"
    }
  }
}

Use the returned settings to configure workspace-specific branding in your apps. Asset IDs reference files stored in the gallery API.