Skip to main content
GET
Get the workspace settings

Authorizations

Authorization
string
header
required

An API key, sent as Authorization: Bearer stfy_live_…. See Authentication for how to get one and which scopes it needs.

Response

200 - application/json

Successful Response

ai_task_auto_close_days
integer
required

AutoClose AI tasks with no updates: days, 1 to 365, before an untouched AI task closes. Default 30

ai_task_update_email_notification
boolean
required

Enable email notifications for Statisfy AI task updates. Default false

automated_email_denylist
string[]
required

Automated Email Denylist: emails and domains whose email is automated, not a person's. Up to 500, each an email or a domain; stored in lowercase, without duplicates

automated_email_patterns
string[]
required

Automated Email Patterns: Python regular expressions matched against a lowercase email address to find automated senders. Up to 100, each 1 to 200 characters

company_domains
string[]
required

Company Domains: the workspace's primary domain first, then its other domains. People with these domains are internal. Read only: change them in the app

enable_weekly_task_overdue_reports
boolean
required

Enable weekly task overdue reports. Default false

health_calculation_cooloff
integer
required

Days, 0 to 365, after an account's CRM Live Date before its health is calculated. Default 7

internal_meeting_tasks
boolean
required

Create tasks from internal meetings. Default false

notetaker_enabled
boolean
required

Enable NoteTaker (Global Setting): whether the NoteTaker joins meetings. Default true

notetaker_followup_email
integer
required

Follow-up Email Recipients: who gets the NoteTaker's follow-up email. 1 = all internal participants; 2 = only Statisfy users. Default 1

notetaker_name
string
required

Notetaker Name: the NoteTaker's name in meetings. 1 to 100 characters, not blank. Default AI NoteTaker

process_meeting
integer
required

Process Meeting (External Call Recorder): which recorded meetings are processed. 1 = a customer or a Statisfy user is on the call; 2 = only meetings with a customer. Default 2

Days, 1 to 365, after a meeting that its shareable link works. Default 14

quarter_start_month
integer
required

Quarter Start Month: the month (1 = January to 12) the fiscal year starts. Default 1

slack_stella_disclosure_message
string
required

Stella Disclosure Message: the note Stella puts above each chat answer. 1 to 1000 characters, not blank

slack_stella_pii_guardrail_enabled
boolean
required

Enable Guardrail for Stella in chat: Stella hides personal data in chat answers to people who are not Statisfy users. Read only: change it in the app

support_escalation_widget_display
boolean
required

Show Support Escalation Widget when empty. Default false

task_escalations
boolean
required

Show Account Escalation Widget when empty. Default false

task_type_customer_goal
boolean
required

Show Goal Widget when empty. Default false