Sign in
workspace-web-search

Get Workspace Web Search Config

Read a workspace's web-search configuration.

Takes the same role as setting it (an organization owner/admin, or an owner/admin of this workspace), because the row describes the workspace's posture rather than one member's allowance. A workspace with no row answers with the unconfigured shape (configured: false), which is the deployment's own behavior described in the same shape rather than a 404.

get/v1/workspaces/{workspace_id}/web-search

Path parameters

workspace_idstring uuid required

Response

Successful Response

allowed_domainsstring[] nullable required
blocked_domainsstring[] nullable required
configuredboolean required
created_atstring nullable required
enabledboolean required
max_resultsinteger nullable required
provider_optionsobject nullable required
purpose_hintstring nullable required
updated_atstring nullable required
web_search_configuredboolean required
workspace_idstring uuid required

Changes

Changed in 1 of the 132 revisions of this API.1