Skip to main content
GET
Get the health 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

additional_fields
AdditionalField · object[]
required

The account fields the workspace picked for the AI to read when it rates health

instructions
Instructions · object
required

The guidance to the AI, by the pillars /v1/health returns

override_days
integer
required

How many days a manual health override holds by default: 7, 14, 30, 60 or 90

product_field
string | null
required

The account field that names the products an account uses (a /v1/fields key); null when none

scale
ScaleLabel · object[] | null
required

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