> For the complete documentation index, see [llms.txt](https://api-docs.myhappyforce.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api-docs.myhappyforce.com/docs/api-reference/hi-configuration-resource.md).

# Hi Configuration Resource

## Explanatory content for the engagement index

> Returns what the index measures, how it is calculated and how to read it, as translatable text. The wording (Happiness Index vs Wellbeing Index) follows the company's configured index terminology.

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[],"servers":[{"url":"{url}","description":"API URL","variables":{"url":{"description":"API Environment","enum":["https://api.happyforce.com","https://staging.happyforce.com","http://localhost:9000"],"default":"https://api.happyforce.com"}}}],"security":[{"companyAPISessionId":[]}],"components":{"securitySchemes":{"companyAPISessionId":{"type":"apiKey","description":"SessionId","name":"SessionId","in":"header"}},"schemas":{"HIConfigurationDTO":{"type":"object","properties":{"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"}}},"MultiLanguage":{"type":"object","description":"A translatable text value: a required default value plus optional per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\"). Consumers resolve the user's language from langValues (falling back to the base language, then to defaultValue).","properties":{"defaultValue":{"type":"string","description":"Fallback text used when there is no entry in langValues for the requested language.","minLength":1},"langValues":{"type":"object","additionalProperties":{"type":"string"},"description":"Per-language overrides keyed by language tag (e.g. \"es\", \"en\", \"pt-BR\")."},"valid":{"type":"boolean"}},"required":["defaultValue"]}}},"paths":{"/api/v1/company/hi/configuration":{"get":{"tags":["hi-configuration-resource"],"summary":"Explanatory content for the engagement index","description":"Returns what the index measures, how it is calculated and how to read it, as translatable text. The wording (Happiness Index vs Wellbeing Index) follows the company's configured index terminology.","operationId":"getHIConfiguration","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/HIConfigurationDTO"}}}}}}}}}
```
