Clarify API
Workspace Settings

List workspace settings

Returns every workspace setting keyed by name, with defaults applied for settings the workspace has not overridden.

GET
/workspaces/{workspace}/settings

Authorization

apiKey
Authorization<token>

API key authentication. Send your key in the Authorization header as: api-key <your-api-key>.

In: header

Path Parameters

workspace*string

The workspace slug — the {slug} segment of your Clarify workspace URL.

Response Body

application/json

curl -X GET "https://example.com/workspaces/string/settings"
{
  "orgDescription": "Acme Corp builds industrial hardware and software.",
  "dealDetectionEnabled": true
}

Reset a workspace setting

Removes the stored value of a workspace setting so it falls back to its default. Read-only settings are rejected, and some settings require admin permissions.

Get a workspace setting

Returns the value of a single workspace setting; the default value when the workspace has not overridden it.