> 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/user-profile-resource.md).

# User Profile Resource

## PUT /api/v1/company/user/info

>

```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":{"UserSelfProfileUpdateDTO":{"type":"object","properties":{"name":{"type":"string"},"password":{"type":"string"},"language":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"}}},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}},"ManagementFocus":{"type":"string","description":"The focus/interest a user has when consuming their report","enum":["TEAM_LEAD","MANAGER_OF_MANAGERS","EXECUTIVE","PEOPLE_ADVISOR","PEOPLE_EXECUTIVE","ACCOUNT_ADMIN","GENERIC"]},"LoginResponse":{"type":"object","properties":{"sessionId":{"type":"string"},"companyUser":{"$ref":"#/components/schemas/UserDTO"}}},"UserDTO":{"type":"object","properties":{"id":{"type":"string"},"rememberMe":{"type":"boolean"},"multipleCompanies":{"type":"boolean"},"pureAdvisor":{"type":"boolean"},"name":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"profileImagePath":{"type":"string"},"email":{"type":"string"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"companyId":{"type":"string"},"language":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"addedOn":{"type":"string","format":"date-time"},"requiresPasswordChange":{"type":"boolean"}}}}},"paths":{"/api/v1/company/user/info":{"put":{"tags":["user-profile-resource"],"operationId":"updateUserProfile","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserSelfProfileUpdateDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LoginResponse"}}}}}}}}}
```

## PUT /api/v1/company/user/filters/{id}

>

```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":{"UserComparisonFilterDTO":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"name":{"type":"string"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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"}}}]}}},"paths":{"/api/v1/company/user/filters/{id}":{"put":{"tags":["user-profile-resource"],"operationId":"updateComparisonFilter","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserComparisonFilterDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserComparisonFilterDTO"}}}}}}}}}
```

## DELETE /api/v1/company/user/filters/{id}

>

```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":{"UserComparisonFilterDTO":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"name":{"type":"string"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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"}}}]}}},"paths":{"/api/v1/company/user/filters/{id}":{"delete":{"tags":["user-profile-resource"],"operationId":"deleteComparisonFilter","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserComparisonFilterDTO"}}}}}}}}}
```

## POST /api/v1/company/user/image

>

```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":{"UserDTO":{"type":"object","properties":{"id":{"type":"string"},"rememberMe":{"type":"boolean"},"multipleCompanies":{"type":"boolean"},"pureAdvisor":{"type":"boolean"},"name":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"profileImagePath":{"type":"string"},"email":{"type":"string"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"companyId":{"type":"string"},"language":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"addedOn":{"type":"string","format":"date-time"},"requiresPasswordChange":{"type":"boolean"}}},"ManagementFocus":{"type":"string","description":"The focus/interest a user has when consuming their report","enum":["TEAM_LEAD","MANAGER_OF_MANAGERS","EXECUTIVE","PEOPLE_ADVISOR","PEOPLE_EXECUTIVE","ACCOUNT_ADMIN","GENERIC"]},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}}}},"paths":{"/api/v1/company/user/image":{"post":{"tags":["user-profile-resource"],"operationId":"uploadUserImage","requestBody":{"content":{"*/*":{"schema":{"type":"object","properties":{"file":{"type":"string","format":"binary"}},"required":["file"]}}}},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserDTO"}}}}}}}}}
```

## GET /api/v1/company/user/filters

>

```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":{"UserComparisonFilterDTO":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"name":{"type":"string"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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"}}}]}}},"paths":{"/api/v1/company/user/filters":{"get":{"tags":["user-profile-resource"],"operationId":"getAllComparisonFilters","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/UserComparisonFilterDTO"}}}}}}}}}}
```

## POST /api/v1/company/user/filters

>

```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":{"UserComparisonFilterDTO":{"type":"object","properties":{"id":{"type":"string"},"userId":{"type":"string"},"name":{"type":"string"},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"groupIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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"}}}]}}},"paths":{"/api/v1/company/user/filters":{"post":{"tags":["user-profile-resource"],"operationId":"create","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserComparisonFilterDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserComparisonFilterDTO"}}}}}}}}}
```

## GET /api/v1/company/user/me

>

```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":{"LoginResponse":{"type":"object","properties":{"sessionId":{"type":"string"},"companyUser":{"$ref":"#/components/schemas/UserDTO"}}},"UserDTO":{"type":"object","properties":{"id":{"type":"string"},"rememberMe":{"type":"boolean"},"multipleCompanies":{"type":"boolean"},"pureAdvisor":{"type":"boolean"},"name":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"profileImagePath":{"type":"string"},"email":{"type":"string"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"hierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"companyId":{"type":"string"},"language":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"addedOn":{"type":"string","format":"date-time"},"requiresPasswordChange":{"type":"boolean"}}},"ManagementFocus":{"type":"string","description":"The focus/interest a user has when consuming their report","enum":["TEAM_LEAD","MANAGER_OF_MANAGERS","EXECUTIVE","PEOPLE_ADVISOR","PEOPLE_EXECUTIVE","ACCOUNT_ADMIN","GENERIC"]},"UserNotificationSetting":{"type":"object","properties":{"type":{"type":"string","enum":["PRIVATE_COMMENT_RECEIVED","INAPPROPRIATE_COMMENT_RECEIVED","COMMENT_RECEIVED","QUESTION_FINISHED"]},"frequency":{"type":"string","enum":["IMMEDIATELY","NEVER"]}}}}},"paths":{"/api/v1/company/user/me":{"get":{"tags":["user-profile-resource"],"operationId":"getUserProfile","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/LoginResponse"}}}}}}}}}
```

## GET /api/v1/company/user/appToken

>

```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":{"UserAppActivationTokenDTO":{"type":"object","properties":{"appActivationToken":{"type":"string"}}}}},"paths":{"/api/v1/company/user/appToken":{"get":{"tags":["user-profile-resource"],"operationId":"retrieveAppCode","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/UserAppActivationTokenDTO"}}}}}}}}}
```
