> ## Documentation Index
> Fetch the complete documentation index at: https://help.statisfy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Get the workspace settings

> The settings of Settings > Config that the API covers: each one's saved value, or its default when no one has changed it. The field names are the app's setting keys.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/settings
openapi: 3.1.0
info:
  description: >-
    The agent-first Statisfy API. Authenticate with an API key (`Authorization:
    Bearer stfy_live_…`), then call `GET /v1/meta/capabilities` to discover
    every operation and its schemas.
  title: Statisfy API
  version: 1.0.0
servers:
  - url: https://api.statisfy.com
    description: Production
security: []
paths:
  /v1/settings:
    get:
      tags:
        - settings
      summary: Get the workspace settings
      description: >-
        The settings of Settings > Config that the API covers: each one's saved
        value, or its default when no one has changed it. The field names are
        the app's setting keys.
      operationId: settings_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceSettings'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    WorkspaceSettings:
      examples:
        - ai_task_auto_close_days: 30
          ai_task_update_email_notification: false
          automated_email_denylist:
            - payroll.com
            - billing@zoom.us
          automated_email_patterns:
            - ^noreply@
            - ^no-reply@
          company_domains:
            - acme.com
            - acme.io
          enable_weekly_task_overdue_reports: true
          health_calculation_cooloff: 7
          internal_meeting_tasks: false
          notetaker_enabled: true
          notetaker_followup_email: 1
          notetaker_name: Acme Notetaker
          process_meeting: 2
          public_activity_link_expiry_days: 14
          quarter_start_month: 2
          slack_stella_disclosure_message: This response is generated by an AI assistant.
          slack_stella_pii_guardrail_enabled: true
          support_escalation_widget_display: false
          task_escalations: false
          task_type_customer_goal: false
      properties:
        ai_task_auto_close_days:
          description: >-
            AutoClose AI tasks with no updates: days, 1 to 365, before an
            untouched AI task closes. Default 30
          title: Ai Task Auto Close Days
          type: integer
        ai_task_update_email_notification:
          description: >-
            Enable email notifications for Statisfy AI task updates. Default
            false
          title: Ai Task Update Email Notification
          type: boolean
        automated_email_denylist:
          description: >-
            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
          items:
            type: string
          title: Automated Email Denylist
          type: array
        automated_email_patterns:
          description: >-
            Automated Email Patterns: Python regular expressions matched against
            a lowercase email address to find automated senders. Up to 100, each
            1 to 200 characters
          items:
            type: string
          title: Automated Email Patterns
          type: array
        company_domains:
          description: >-
            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
          items:
            type: string
          title: Company Domains
          type: array
        enable_weekly_task_overdue_reports:
          description: Enable weekly task overdue reports. Default false
          title: Enable Weekly Task Overdue Reports
          type: boolean
        health_calculation_cooloff:
          description: >-
            Days, 0 to 365, after an account's CRM Live Date before its health
            is calculated. Default 7
          title: Health Calculation Cooloff
          type: integer
        internal_meeting_tasks:
          description: Create tasks from internal meetings. Default false
          title: Internal Meeting Tasks
          type: boolean
        notetaker_enabled:
          description: >-
            Enable NoteTaker (Global Setting): whether the NoteTaker joins
            meetings. Default true
          title: Notetaker Enabled
          type: boolean
        notetaker_followup_email:
          description: >-
            Follow-up Email Recipients: who gets the NoteTaker's follow-up
            email. 1 = all internal participants; 2 = only Statisfy users.
            Default 1
          title: Notetaker Followup Email
          type: integer
        notetaker_name:
          description: >-
            Notetaker Name: the NoteTaker's name in meetings. 1 to 100
            characters, not blank. Default AI NoteTaker
          title: Notetaker Name
          type: string
        process_meeting:
          description: >-
            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
          title: Process Meeting
          type: integer
        public_activity_link_expiry_days:
          description: >-
            Days, 1 to 365, after a meeting that its shareable link works.
            Default 14
          title: Public Activity Link Expiry Days
          type: integer
        quarter_start_month:
          description: >-
            Quarter Start Month: the month (1 = January to 12) the fiscal year
            starts. Default 1
          title: Quarter Start Month
          type: integer
        slack_stella_disclosure_message:
          description: >-
            Stella Disclosure Message: the note Stella puts above each chat
            answer. 1 to 1000 characters, not blank
          title: Slack Stella Disclosure Message
          type: string
        slack_stella_pii_guardrail_enabled:
          description: >-
            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
          title: Slack Stella Pii Guardrail Enabled
          type: boolean
        support_escalation_widget_display:
          description: Show Support Escalation Widget when empty. Default false
          title: Support Escalation Widget Display
          type: boolean
        task_escalations:
          description: Show Account Escalation Widget when empty. Default false
          title: Task Escalations
          type: boolean
        task_type_customer_goal:
          description: Show Goal Widget when empty. Default false
          title: Task Type Customer Goal
          type: boolean
      required:
        - quarter_start_month
        - ai_task_auto_close_days
        - health_calculation_cooloff
        - internal_meeting_tasks
        - process_meeting
        - public_activity_link_expiry_days
        - slack_stella_disclosure_message
        - slack_stella_pii_guardrail_enabled
        - support_escalation_widget_display
        - task_escalations
        - task_type_customer_goal
        - automated_email_denylist
        - automated_email_patterns
        - company_domains
        - notetaker_enabled
        - notetaker_name
        - notetaker_followup_email
        - ai_task_update_email_notification
        - enable_weekly_task_overdue_reports
      title: WorkspaceSettings
      type: object
  securitySchemes:
    HTTPBearer:
      scheme: bearer
      type: http
      description: >-
        An API key, sent as `Authorization: Bearer stfy_live_…`. See
        [Authentication](/rest-api/authentication) for how to get one and which
        scopes it needs.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.