client.workspaceSettingsOperation methods
Parameter declarations below are taken from the pinned TypeScript source. Request fields and responses are summarized from the matching OpenAPI operation; follow the API link for every field, constraint, example, and error description.
/workspace/settingsworkspaceSettings.get
Use this operation to get public workspace settings. It returns the resource only when it belongs to the authenticated workspace and is visible to the credential. Required scopes, product permissions, sharing rules, workspace locks, and regional cell ownership are enforced for every request.
client.workspaceSettings.get(options: RequestOptions = {})- Return form
Promise- Operation ID
getWorkspaceSettings- Required scopes
workspace-settings:read- SDK parameters
options: RequestOptions- Success
200 WorkspaceSettings envelope
/workspace/settingsworkspaceSettings.update
Atomically compares the complete public settings revision, applies only the six documented settings, durably audits the write, and retains a recoverable credential-owned idempotency record for seven days.
client.workspaceSettings.update(data: WorkspaceSettingsUpdate, options: WorkspaceSettingsMutationOptions)- Return form
Promise- Operation ID
updateWorkspaceSettings- Required scopes
workspace-settings:write- SDK parameters
data: WorkspaceSettingsUpdateoptions: WorkspaceSettingsMutationOptions- Header request fields
If-Match: stringIdempotency-Key: string- Request body
WorkspaceSettingsUpdateapplication/json- Success
200 WorkspaceSettings envelope
Errors and transport metadata
HTTP failures reject with TeamGridApiError, including the status, stable error documents, request ID, optional retry delay, and transport metadata. Local validation, routing, timeout, response-size, and pagination failures reject withTeamGridClientError and a stable client error code. Successful envelopes expose non-enumerable transport metadata.
See pagination and errors andclient configuration for handling guidance.