Docs: Tool reference
admin toolset

get_workspace_settings

Get workspace settings. The workspace's portal settings, branding (logo, favicon, color, header links), customer email sender name and reply-to, and custom domain with its DNS status and the records to create. Team only. No side effects.

Toolset
admin
Who can call it
OwnersManagersContributorsAPI keys
REST
GET /api/v1/w/{workspace}/settings
Behavior
read-onlyidempotent

Input

No input.

Output

FieldTypeDescription
namerequiredstringThe workspace's name, shown on the portal and in emails.
portal_settingsrequiredobject
brandingrequiredobject
emailrequiredobjectHow customer emails are sent: sender name and reply-to.
custom_domainrequiredobject or null
portal_urlrequiredstring (uri)
versionrequiredinteger

Calling it

// MCP: tools/call
{ "name": "get_workspace_settings", "arguments": {} }

// Typed client
await carechannel.get_workspace_settings({});