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

# People Resource

## GET /api/v1/company/people

>

```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":{"PersonDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"addedBy":{"type":"string"},"sourceType":{"type":"string","enum":["REGISTRATION","USER","SELF","API","API_INTERNAL","SSO"]},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"capabilities":{"type":"array","items":{"type":"string","enum":["CAN_ANSWER_CONVERSATIONS"]},"uniqueItems":true},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"blocked":{"type":"boolean"},"debug":{"type":"boolean"},"language":{"type":"string"},"activated":{"type":"boolean"},"deleted":{"type":"boolean"},"turnoverDate":{"type":"string","format":"date-time"},"turnoverType":{"$ref":"#/components/schemas/EmployeeTurnOverTypes"},"regrettable":{"type":"boolean"},"addedOn":{"type":"string","format":"date-time"},"deletedOn":{"type":"string","format":"date-time"},"email":{"type":"string"},"externalId":{"type":"string"},"internalId":{"type":"integer","format":"int32"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"appActivationToken":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true}}},"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"]},"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"}}}]},"EmployeeTurnOverTypes":{"type":"string","description":"Type of feedback","enum":["VOLUNTARY","INVOLUNTARY","OTHER"]},"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/people":{"get":{"tags":["people-resource"],"operationId":"getPerson","parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}},{"name":"externalId","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonDTO"}}}}}}}}}
```

## POST /api/v1/company/people

>

```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":{"PersonDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"addedBy":{"type":"string"},"sourceType":{"type":"string","enum":["REGISTRATION","USER","SELF","API","API_INTERNAL","SSO"]},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"capabilities":{"type":"array","items":{"type":"string","enum":["CAN_ANSWER_CONVERSATIONS"]},"uniqueItems":true},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"blocked":{"type":"boolean"},"debug":{"type":"boolean"},"language":{"type":"string"},"activated":{"type":"boolean"},"deleted":{"type":"boolean"},"turnoverDate":{"type":"string","format":"date-time"},"turnoverType":{"$ref":"#/components/schemas/EmployeeTurnOverTypes"},"regrettable":{"type":"boolean"},"addedOn":{"type":"string","format":"date-time"},"deletedOn":{"type":"string","format":"date-time"},"email":{"type":"string"},"externalId":{"type":"string"},"internalId":{"type":"integer","format":"int32"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"appActivationToken":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true}}},"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"]},"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"}}}]},"EmployeeTurnOverTypes":{"type":"string","description":"Type of feedback","enum":["VOLUNTARY","INVOLUNTARY","OTHER"]},"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/people":{"post":{"tags":["people-resource"],"operationId":"invitePerson","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonDTO"}}}}}}}}}
```

## PUT /api/v1/company/people

>

```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":{"PersonDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"addedBy":{"type":"string"},"sourceType":{"type":"string","enum":["REGISTRATION","USER","SELF","API","API_INTERNAL","SSO"]},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"capabilities":{"type":"array","items":{"type":"string","enum":["CAN_ANSWER_CONVERSATIONS"]},"uniqueItems":true},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"blocked":{"type":"boolean"},"debug":{"type":"boolean"},"language":{"type":"string"},"activated":{"type":"boolean"},"deleted":{"type":"boolean"},"turnoverDate":{"type":"string","format":"date-time"},"turnoverType":{"$ref":"#/components/schemas/EmployeeTurnOverTypes"},"regrettable":{"type":"boolean"},"addedOn":{"type":"string","format":"date-time"},"deletedOn":{"type":"string","format":"date-time"},"email":{"type":"string"},"externalId":{"type":"string"},"internalId":{"type":"integer","format":"int32"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"appActivationToken":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true}}},"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"]},"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"}}}]},"EmployeeTurnOverTypes":{"type":"string","description":"Type of feedback","enum":["VOLUNTARY","INVOLUNTARY","OTHER"]},"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/people":{"put":{"tags":["people-resource"],"operationId":"updatePerson","requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonDTO"}}},"required":true},"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonDTO"}}}}}}}}}
```

## DELETE /api/v1/company/people

>

```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":{"EmployeeTurnOverTypes":{"type":"string","description":"Type of feedback","enum":["VOLUNTARY","INVOLUNTARY","OTHER"]},"PersonDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"addedBy":{"type":"string"},"sourceType":{"type":"string","enum":["REGISTRATION","USER","SELF","API","API_INTERNAL","SSO"]},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"capabilities":{"type":"array","items":{"type":"string","enum":["CAN_ANSWER_CONVERSATIONS"]},"uniqueItems":true},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"blocked":{"type":"boolean"},"debug":{"type":"boolean"},"language":{"type":"string"},"activated":{"type":"boolean"},"deleted":{"type":"boolean"},"turnoverDate":{"type":"string","format":"date-time"},"turnoverType":{"$ref":"#/components/schemas/EmployeeTurnOverTypes"},"regrettable":{"type":"boolean"},"addedOn":{"type":"string","format":"date-time"},"deletedOn":{"type":"string","format":"date-time"},"email":{"type":"string"},"externalId":{"type":"string"},"internalId":{"type":"integer","format":"int32"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"appActivationToken":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true}}},"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"]},"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"}}}]},"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/people":{"delete":{"tags":["people-resource"],"operationId":"deletePerson","parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}},{"name":"turnoverDate","in":"query","required":false,"schema":{"type":"string","format":"date-time"}},{"name":"turnoverType","in":"query","required":false,"schema":{"$ref":"#/components/schemas/EmployeeTurnOverTypes"}},{"name":"regrettable","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonDTO"}}}}}}}}}
```

## POST /api/v1/company/people/resubscribe

>

```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":{"PersonDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"addedBy":{"type":"string"},"sourceType":{"type":"string","enum":["REGISTRATION","USER","SELF","API","API_INTERNAL","SSO"]},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"capabilities":{"type":"array","items":{"type":"string","enum":["CAN_ANSWER_CONVERSATIONS"]},"uniqueItems":true},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"blocked":{"type":"boolean"},"debug":{"type":"boolean"},"language":{"type":"string"},"activated":{"type":"boolean"},"deleted":{"type":"boolean"},"turnoverDate":{"type":"string","format":"date-time"},"turnoverType":{"$ref":"#/components/schemas/EmployeeTurnOverTypes"},"regrettable":{"type":"boolean"},"addedOn":{"type":"string","format":"date-time"},"deletedOn":{"type":"string","format":"date-time"},"email":{"type":"string"},"externalId":{"type":"string"},"internalId":{"type":"integer","format":"int32"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"appActivationToken":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true}}},"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"]},"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"}}}]},"EmployeeTurnOverTypes":{"type":"string","description":"Type of feedback","enum":["VOLUNTARY","INVOLUNTARY","OTHER"]},"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/people/resubscribe":{"post":{"tags":["people-resource"],"operationId":"resubscribeToEmail","parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonDTO"}}}}}}}}}
```

## POST /api/v1/company/people/resendInvite

>

```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":{"PersonDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"addedBy":{"type":"string"},"sourceType":{"type":"string","enum":["REGISTRATION","USER","SELF","API","API_INTERNAL","SSO"]},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"capabilities":{"type":"array","items":{"type":"string","enum":["CAN_ANSWER_CONVERSATIONS"]},"uniqueItems":true},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"blocked":{"type":"boolean"},"debug":{"type":"boolean"},"language":{"type":"string"},"activated":{"type":"boolean"},"deleted":{"type":"boolean"},"turnoverDate":{"type":"string","format":"date-time"},"turnoverType":{"$ref":"#/components/schemas/EmployeeTurnOverTypes"},"regrettable":{"type":"boolean"},"addedOn":{"type":"string","format":"date-time"},"deletedOn":{"type":"string","format":"date-time"},"email":{"type":"string"},"externalId":{"type":"string"},"internalId":{"type":"integer","format":"int32"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"appActivationToken":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true}}},"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"]},"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"}}}]},"EmployeeTurnOverTypes":{"type":"string","description":"Type of feedback","enum":["VOLUNTARY","INVOLUNTARY","OTHER"]},"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/people/resendInvite":{"post":{"tags":["people-resource"],"operationId":"resendInvite","parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"string"}},{"name":"email","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonDTO"}}}}}}}}}
```

## POST /api/v1/company/people/reminder/{target}

>

```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":{"EmployeeSendReminderRequest":{"type":"object","properties":{"subject":{"$ref":"#/components/schemas/MultiLanguage"},"content":{"$ref":"#/components/schemas/MultiLanguage"},"signWithUserName":{"type":"boolean"},"sendSample":{"type":"boolean"},"monthsInactive":{"type":"integer","format":"int32","description":"Months of inactivity for the SLEEPING target. Allowed values: 1, 3, 6. Defaults to 3 when omitted. Ignored for NON_ACTIVATED."}}},"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/people/reminder/{target}":{"post":{"tags":["people-resource"],"operationId":"engageInactives","parameters":[{"name":"target","in":"path","required":true,"schema":{"type":"string","enum":["SLEEPING","NON_ACTIVATED"]}},{"name":"hierarchyId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}}],"requestBody":{"content":{"*/*":{"schema":{"$ref":"#/components/schemas/EmployeeSendReminderRequest"}}},"required":true},"responses":{"200":{"description":"OK"}}}}}}
```

## GET /api/v1/company/people/template/{templateType}

>

```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":{"EmployeeTemplateType":{"type":"string","description":"Type of employee template to download","enum":["INVITE","DELETE","UPDATE","TURNOVER"]}}},"paths":{"/api/v1/company/people/template/{templateType}":{"get":{"tags":["people-resource"],"operationId":"downloadTemplate","parameters":[{"name":"templateType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/EmployeeTemplateType"}}],"responses":{"200":{"description":"OK","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}},"*/*":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```

## GET /api/v1/company/people/profile

>

```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":{"PersonProfileDTO":{"type":"object","properties":{"email":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"capabilities":{"type":"array","items":{"type":"string","enum":["CAN_ANSWER_CONVERSATIONS"]},"uniqueItems":true},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true}}},"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"]}}},"paths":{"/api/v1/company/people/profile":{"get":{"tags":["people-resource"],"operationId":"getPersonProfile","parameters":[{"name":"id","in":"query","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PersonProfileDTO"}}}}}}}}}
```

## GET /api/v1/company/people/find

>

```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":{"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"]},"PaginableGenericListResultPersonDTO":{"type":"object","properties":{"from":{"type":"integer","format":"int32"},"to":{"type":"integer","format":"int32"},"total":{"type":"integer","format":"int32"},"noContent":{"type":"boolean"},"results":{"type":"array","items":{"$ref":"#/components/schemas/PersonDTO"}}}},"PersonDTO":{"type":"object","properties":{"id":{"type":"string"},"companyId":{"type":"string"},"name":{"type":"string"},"profileImagePath":{"type":"string"},"addedBy":{"type":"string"},"sourceType":{"type":"string","enum":["REGISTRATION","USER","SELF","API","API_INTERNAL","SSO"]},"role":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"managementFocus":{"$ref":"#/components/schemas/ManagementFocus"},"capabilities":{"type":"array","items":{"type":"string","enum":["CAN_ANSWER_CONVERSATIONS"]},"uniqueItems":true},"managedHierarchyIds":{"type":"array","items":{"type":"string"},"uniqueItems":true},"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},"groups":{"type":"array","items":{"type":"string"},"uniqueItems":true},"blocked":{"type":"boolean"},"debug":{"type":"boolean"},"language":{"type":"string"},"activated":{"type":"boolean"},"deleted":{"type":"boolean"},"turnoverDate":{"type":"string","format":"date-time"},"turnoverType":{"$ref":"#/components/schemas/EmployeeTurnOverTypes"},"regrettable":{"type":"boolean"},"addedOn":{"type":"string","format":"date-time"},"deletedOn":{"type":"string","format":"date-time"},"email":{"type":"string"},"externalId":{"type":"string"},"internalId":{"type":"integer","format":"int32"},"mailStatus":{"type":"string","enum":["SENT","DELIVERED","OPEN","DEFERRAL","HARDBOUNCE","SOFTBOUNCE","SPAM","UNSUB","REJECTED","DELAYED","OTHER"]},"appActivationToken":{"type":"string"},"mailNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"uniqueItems":true},"pushNotificationSettings":{"type":"array","items":{"$ref":"#/components/schemas/UserNotificationSetting"},"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"}}}]},"EmployeeTurnOverTypes":{"type":"string","description":"Type of feedback","enum":["VOLUNTARY","INVOLUNTARY","OTHER"]},"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/people/find":{"get":{"tags":["people-resource"],"operationId":"getEmployees_1","parameters":[{"name":"from","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":0}},{"name":"to","in":"query","required":false,"schema":{"type":"integer","format":"int32","default":10}},{"name":"activated","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"deleted","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"hierarchyId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"}}},{"name":"filters","in":"query","required":false,"schema":{"type":"string"}},{"name":"groupId","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"uniqueItems":true}},{"name":"text","in":"query","required":false,"schema":{"type":"string"}},{"name":"mailStatus","in":"query","required":false,"schema":{"type":"string","enum":["CORRECT","UNKNOWN","FAILING","UNSUBSCRIBED"]}},{"name":"role","in":"query","required":false,"schema":{"type":"array","items":{"type":"string","enum":["ADVISOR","ADMIN","RESPONSIBLE","PUBLIC","MANAGER","EMPLOYEE"]},"uniqueItems":true}},{"name":"managementFocus","in":"query","required":false,"schema":{"type":"array","items":{"$ref":"#/components/schemas/ManagementFocus"},"uniqueItems":true}},{"name":"orderBy","in":"query","required":false,"schema":{"type":"string","enum":["email","name","addedOn","invitedOn"]}},{"name":"orderDesc","in":"query","required":false,"schema":{"type":"boolean","default":false}},{"name":"withoutArea","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"incompleteProfile","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"blocked","in":"query","required":false,"schema":{"type":"boolean"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/PaginableGenericListResultPersonDTO"}}}}}}}}}
```
