> 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/configuration.md).

# Configuration

## POST /api/v1/employee/configuration/{employeeId}

> Sets the configuration of an employee.&#x20;

```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":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"EmployeeParticipationProfileConfigureRequest":{"type":"object","properties":{"hierarchyId":{"type":"string"},"characteristics":{"type":"array","items":{"oneOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBoolean"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueDate"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueList"},{"$ref":"#/components/schemas/EmployeeCharacteristicValueTree"}]},"uniqueItems":true}}},"EmployeeCharacteristicValueBoolean":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"boolean"}}}]},"EmployeeCharacteristicValueBase":{"type":"object","description":"Base class for employee characteristic values","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/EmployeeCharacteristicValueList","DATE":"#/components/schemas/EmployeeCharacteristicValueDate","BOOLEAN":"#/components/schemas/EmployeeCharacteristicValueBoolean","TREE":"#/components/schemas/EmployeeCharacteristicValueTree"}},"properties":{"characteristicId":{"type":"string"},"id":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}}},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN","TREE"]},"EmployeeCharacteristicValueDate":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"date":{"type":"string","format":"date-time"},"value":{"type":"string"}}}]},"EmployeeCharacteristicValueList":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"}}}]},"EmployeeCharacteristicValueTree":{"allOf":[{"$ref":"#/components/schemas/EmployeeCharacteristicValueBase"},{"type":"object","properties":{"value":{"type":"string"},"assignedPath":{"type":"array","items":{"type":"string"}},"assignedOn":{"type":"string","format":"date-time"}}}]},"EmployeeLoginResponse":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"companyName":{"type":"string"},"companyTimeZone":{"type":"string"},"appStyle":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"configCompleted":{"type":"boolean"},"requireVote":{"type":"boolean"},"pendingAnnouncements":{"type":"boolean"},"pendingFeedback":{"type":"boolean"},"pendingConversations":{"type":"boolean","description":"Whether the user has pending conversations to show on login (open, with the last message from the company side, not the employee's own). When true, fetch the list from GET /v1/employee/conversations/{employeeId}/pending."},"conversationsDisplayMoment":{"$ref":"#/components/schemas/ConversationsDisplayMoment","description":"When pendingConversations is true, whether the on-login conversations list should be shown BEFORE_VOTE or AFTER_VOTE. Null when the on-login conversations feature is disabled."},"requireFirstTimeCommentFilter":{"type":"boolean"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"debug":{"type":"boolean"},"canResetProfile":{"type":"boolean"},"canManage":{"type":"boolean"},"canBlockUsers":{"type":"boolean"},"hasHFMe":{"type":"boolean","deprecated":true},"canHFMe":{"type":"boolean"},"canRegisterTime":{"type":"boolean"},"hfMeActivated":{"type":"boolean"},"canUseHero":{"type":"boolean"},"rewardsEnabled":{"type":"boolean"},"podiumEnabled":{"type":"boolean","description":"Whether the monthly rewards podium is enabled (rewards enabled AND the podium turned on). Gates the podium tab independently of the rest of the rewards UI."},"canManageHierarchy":{"type":"boolean"},"externalId":{"type":"string"},"votingFlow":{"type":"string","enum":["QUESTIONS","ANNOUNCEMENTS"]},"indexTerminology":{"$ref":"#/components/schemas/IndexTerminology"}}},"ConversationsDisplayMoment":{"type":"string","enum":["BEFORE_VOTE","AFTER_VOTE"]},"IndexTerminology":{"type":"string","description":"Vocabulary a company uses for its engagement index. HAPPINESS keeps the historical \"Happiness Index\" wording (default for existing companies); WELLBEING shows the \"Wellbeing Index\" wording. Presentation only — it does not change how the index is computed.","enum":["HAPPINESS","WELLBEING"]}}},"paths":{"/api/v1/employee/configuration/{employeeId}":{"post":{"tags":["Configuration"],"description":"Sets the configuration of an employee. ","operationId":"configureEmployee","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeParticipationProfileConfigureRequest"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeLoginResponse"}}}}}}}}}
```

## DELETE /api/v1/employee/configuration/{employeeId}

> Resets the configuration of an employee.&#x20;

```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":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"EmployeeLoginResponse":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"companyName":{"type":"string"},"companyTimeZone":{"type":"string"},"appStyle":{"type":"string"},"hierarchyId":{"type":"string"},"hierarchyName":{"type":"string"},"configCompleted":{"type":"boolean"},"requireVote":{"type":"boolean"},"pendingAnnouncements":{"type":"boolean"},"pendingFeedback":{"type":"boolean"},"pendingConversations":{"type":"boolean","description":"Whether the user has pending conversations to show on login (open, with the last message from the company side, not the employee's own). When true, fetch the list from GET /v1/employee/conversations/{employeeId}/pending."},"conversationsDisplayMoment":{"$ref":"#/components/schemas/ConversationsDisplayMoment","description":"When pendingConversations is true, whether the on-login conversations list should be shown BEFORE_VOTE or AFTER_VOTE. Null when the on-login conversations feature is disabled."},"requireFirstTimeCommentFilter":{"type":"boolean"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"debug":{"type":"boolean"},"canResetProfile":{"type":"boolean"},"canManage":{"type":"boolean"},"canBlockUsers":{"type":"boolean"},"hasHFMe":{"type":"boolean","deprecated":true},"canHFMe":{"type":"boolean"},"canRegisterTime":{"type":"boolean"},"hfMeActivated":{"type":"boolean"},"canUseHero":{"type":"boolean"},"rewardsEnabled":{"type":"boolean"},"podiumEnabled":{"type":"boolean","description":"Whether the monthly rewards podium is enabled (rewards enabled AND the podium turned on). Gates the podium tab independently of the rest of the rewards UI."},"canManageHierarchy":{"type":"boolean"},"externalId":{"type":"string"},"votingFlow":{"type":"string","enum":["QUESTIONS","ANNOUNCEMENTS"]},"indexTerminology":{"$ref":"#/components/schemas/IndexTerminology"}}},"ConversationsDisplayMoment":{"type":"string","enum":["BEFORE_VOTE","AFTER_VOTE"]},"IndexTerminology":{"type":"string","description":"Vocabulary a company uses for its engagement index. HAPPINESS keeps the historical \"Happiness Index\" wording (default for existing companies); WELLBEING shows the \"Wellbeing Index\" wording. Presentation only — it does not change how the index is computed.","enum":["HAPPINESS","WELLBEING"]}}},"paths":{"/api/v1/employee/configuration/{employeeId}":{"delete":{"tags":["Configuration"],"description":"Resets the configuration of an employee. ","operationId":"resetEmployeeConfig","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmployeeLoginResponse"}}}}}}}}}
```

## POST /api/v1/employee/configuration/{employeeId}/settings

> Get's the  employees current personal configuration. &#x20;

```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":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"PersonalConfigurationDTO":{"type":"object","description":"Personal configuration for the current user: e.g. whether Me section is activated.","properties":{"meActivated":{"type":"boolean","description":"Whether the Me / personal area is activated"}}}}},"paths":{"/api/v1/employee/configuration/{employeeId}/settings":{"post":{"tags":["Configuration"],"description":"Get's the  employees current personal configuration.  ","operationId":"setEmployeePersonalConfiguration","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalConfigurationDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PersonalConfigurationDTO"}}}}}}}}}
```

## GET /api/v1/employee/configuration/{employeeId}/company

> Get's the  employees current participation configuration. &#x20;

```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":[{"employeeAPISessionId":[]}],"components":{"securitySchemes":{},"schemas":{"ParticipationProfileConfigurationDTO":{"type":"object","description":"Participation profile configuration: hierarchy and characteristics (segments) for the user.","properties":{"hierarchy":{"type":"array","description":"Hierarchy nodes applicable to the user","items":{"$ref":"#/components/schemas/EmployeeHierarchyDTO"}},"characteristics":{"type":"array","description":"Company characteristics (segment questions) and their values","items":{"oneOf":[{"$ref":"#/components/schemas/CompanyCharacteristicDateDTO"},{"$ref":"#/components/schemas/CompanyCharacteristicListDTO"},{"$ref":"#/components/schemas/CompanyCharacteristicTreeDTO"}]}}}},"EmployeeHierarchyDTO":{"type":"object","description":"Employee hierarchy node: id, parent id, name, and children (recursive structure).","properties":{"id":{"type":"string","description":"Hierarchy node identifier"},"parentId":{"type":"string","description":"Parent node identifier"},"name":{"type":"string","description":"Display name of the hierarchy node"},"children":{"type":"array","description":"Child nodes","items":{"description":"Employee hierarchy node: id, parent id, name, and children (recursive structure)."},"uniqueItems":true}}},"CompanyCharacteristicDateDTO":{"allOf":[{"$ref":"#/components/schemas/CompanyCharacteristicBaseDTO"}],"description":"Company characteristic of type DATE."},"CompanyCharacteristicBaseDTO":{"type":"object","description":"Base for company characteristic (employee segment): discriminated by questionType (LIST, DATE or TREE).","discriminator":{"propertyName":"questionType","mapping":{"LIST":"#/components/schemas/CompanyCharacteristicListDTO","DATE":"#/components/schemas/CompanyCharacteristicDateDTO","TREE":"#/components/schemas/CompanyCharacteristicTreeDTO"}},"properties":{"id":{"type":"string"},"question":{"type":"string"},"questionType":{"$ref":"#/components/schemas/CharacteristicType"}},"required":["question","questionType"]},"CharacteristicType":{"type":"string","description":"Type of segmentation characteristic","enum":["DATE","LIST","BOOLEAN","TREE"]},"CompanyCharacteristicListDTO":{"allOf":[{"$ref":"#/components/schemas/CompanyCharacteristicBaseDTO"},{"type":"object","properties":{"values":{"type":"array","items":{"$ref":"#/components/schemas/CompanyCharacteristicListItemDTO"}}}}],"description":"Company characteristic of type LIST: list of segment values."},"CompanyCharacteristicListItemDTO":{"type":"object","description":"Single item in a list characteristic: id, value, position.","properties":{"id":{"type":"string","description":"Item identifier"},"value":{"type":"string","description":"Display value"},"position":{"type":"integer","format":"int32","description":"Display order position"}}},"CompanyCharacteristicTreeDTO":{"allOf":[{"$ref":"#/components/schemas/CompanyCharacteristicBaseDTO"},{"type":"object","properties":{"rootNodes":{"type":"array","items":{"$ref":"#/components/schemas/CompanyCharacteristicTreeNodeDTO"}}}}],"description":"Company characteristic of type TREE: hierarchical nodes. Employees may only be assigned to leaf nodes."},"CompanyCharacteristicTreeNodeDTO":{"type":"object","description":"Single node in a tree characteristic. Leaf nodes have empty children; only leaves can be assigned to an employee.","properties":{"id":{"type":"string","description":"Node identifier"},"value":{"type":"string","description":"Display value (already translated to the user's language)"},"position":{"type":"integer","format":"int32","description":"Display order position among siblings"},"children":{"type":"array","description":"Child nodes. Empty / null for leaves.","items":{"$ref":"#/components/schemas/CompanyCharacteristicTreeNodeDTO"}}}}}},"paths":{"/api/v1/employee/configuration/{employeeId}/company":{"get":{"tags":["Configuration"],"description":"Get's the  employees current participation configuration.  ","operationId":"getEmployeeCompanyConfiguration","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ParticipationProfileConfigurationDTO"}}}}}}}}}
```
