> ## 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 health settings

> How the workspace rates account health: its health labels and the levels each covers, how long a manual override holds, the guidance the AI gets per pillar, and the account fields it reads. The labels, levels and pillars are the ones /v1/health returns. Read only: change them in the app.



## OpenAPI

````yaml /api/statisfy-api.openapi.json get /v1/settings/health
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/health:
    get:
      tags:
        - settings
      summary: Get the health settings
      description: >-
        How the workspace rates account health: its health labels and the levels
        each covers, how long a manual override holds, the guidance the AI gets
        per pillar, and the account fields it reads. The labels, levels and
        pillars are the ones /v1/health returns. Read only: change them in the
        app.
      operationId: settings_health_get
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HealthSettings'
          description: Successful Response
      security:
        - HTTPBearer: []
components:
  schemas:
    HealthSettings:
      examples:
        - additional_fields:
            - description: Latest NPS response
              field: nps_score
          instructions:
            overallHealth: Weigh executive sponsor changes heavily.
          override_days: 30
          product_field: product_tier
          scale:
            - default_level: Positive
              label: Green
              levels:
                - Very Positive
                - Positive
                - Slightly Positive
            - default_level: Neutral
              label: Yellow
              levels:
                - Neutral
                - Slightly Negative
            - default_level: Negative
              label: Red
              levels:
                - Negative
                - Very Negative
      properties:
        additional_fields:
          description: >-
            The account fields the workspace picked for the AI to read when it
            rates health
          items:
            $ref: '#/components/schemas/AdditionalField'
          title: Additional Fields
          type: array
        instructions:
          $ref: '#/components/schemas/Instructions'
          description: The guidance to the AI, by the pillars /v1/health returns
        override_days:
          description: >-
            How many days a manual health override holds by default: 7, 14, 30,
            60 or 90
          title: Override Days
          type: integer
        product_field:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The account field that names the products an account uses (a
            /v1/fields key); null when none
          title: Product Field
        scale:
          anyOf:
            - items:
                $ref: '#/components/schemas/ScaleLabel'
              type: array
            - type: 'null'
          description: >-
            The workspace's health labels. Each 7-point level is in exactly one
            label. Null: no custom scale, so /v1/health's `health` is the level
            itself
          title: Scale
      required:
        - scale
        - override_days
        - instructions
        - product_field
        - additional_fields
      title: HealthSettings
      type: object
    AdditionalField:
      properties:
        description:
          description: What the field means, as the workspace wrote it for the AI
          title: Description
          type: string
        field:
          description: The account field, as /v1/fields keys it
          title: Field
          type: string
      required:
        - field
        - description
      title: AdditionalField
      type: object
    Instructions:
      properties:
        experience:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The workspace's guidance to the AI for experience; null when none is
            written
          title: Experience
        featureRequests:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The workspace's guidance to the AI for feature requests; null when
            none is written
          title: Featurerequests
        outcomes:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The workspace's guidance to the AI for outcomes; null when none is
            written
          title: Outcomes
        overallHealth:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The workspace's guidance to the AI for the overall health; null when
            none is written
          title: Overallhealth
        productUsage:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The workspace's guidance to the AI for product usage; null when none
            is written
          title: Productusage
        relationship:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The workspace's guidance to the AI for the relationship; null when
            none is written
          title: Relationship
        risks:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The workspace's guidance to the AI for risks; null when none is
            written
          title: Risks
      required:
        - overallHealth
        - productUsage
        - relationship
        - outcomes
        - experience
        - featureRequests
        - risks
      title: Instructions
      type: object
    ScaleLabel:
      properties:
        default_level:
          description: The level a manual health entry of this label gets
          enum:
            - Very Positive
            - Positive
            - Slightly Positive
            - Neutral
            - Slightly Negative
            - Negative
            - Very Negative
          title: Default Level
          type: string
        label:
          description: The label, as /v1/health returns it in `health`
          title: Label
          type: string
        levels:
          description: The 7-point levels this label covers, Very Positive first
          items:
            enum:
              - Very Positive
              - Positive
              - Slightly Positive
              - Neutral
              - Slightly Negative
              - Negative
              - Very Negative
            type: string
          title: Levels
          type: array
      required:
        - label
        - levels
        - default_level
      title: ScaleLabel
      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.