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

# Me (deprecated)

## GET /api/v1/employee/me/{employeeId}

> Get's the the status and  of the logged person

```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":{"MeOverviewDTO":{"type":"object","description":"Overview for the current user: flags for votes, engagement, HI details, personal report; minimum votes; deprecated HI/distribution fields.","properties":{"hasEnoughVotes":{"type":"boolean"},"hasEngagement":{"type":"boolean"},"hasHiDetails":{"type":"boolean"},"hasPersonalReport":{"type":"boolean"},"minimumVotes":{"type":"integer","format":"int32"},"hi":{"type":"number","format":"double","deprecated":true},"periodDays":{"type":"integer","format":"int32","deprecated":true},"totalVotes":{"type":"integer","format":"int32","deprecated":true},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32","deprecated":true},"deprecated":true},"votesByDate":{"type":"object","additionalProperties":{"type":"integer","format":"int32","deprecated":true},"deprecated":true},"questionValues":{"type":"array","deprecated":true,"items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true},"engagementResume":{"$ref":"#/components/schemas/MeEngagementDTO","deprecated":true}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"},"reflectionPrompt":{"type":"string","description":"Reflection prompt, in case the question has an additional comment option enabled"}}},"MeEngagementDTO":{"type":"object","description":"Engagement values for the current user: personal, team, and company values and valuations.","properties":{"personalValue":{"type":"number","format":"double"},"personalValuation":{"$ref":"#/components/schemas/ValuationType"},"teamValue":{"type":"number","format":"double"},"teamValuation":{"$ref":"#/components/schemas/ValuationType"},"teamName":{"type":"string"},"companyValue":{"type":"number","format":"double"},"companyName":{"type":"string"},"companyValuation":{"$ref":"#/components/schemas/ValuationType"},"maxValue":{"type":"number","format":"double"},"totalQuestionsCount":{"type":"integer","format":"int32"},"currentQuestionsCount":{"type":"integer","format":"int32"},"outdatedQuestionsCount":{"type":"integer","format":"int32"},"ageQuality":{"$ref":"#/components/schemas/DataQuality"},"amountQuality":{"$ref":"#/components/schemas/DataQuality"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}},"paths":{"/api/v1/employee/me/{employeeId}":{"get":{"tags":["Me (deprecated)"],"description":"Get's the the status and  of the logged person","operationId":"getHFMeStatusOverview","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeOverviewDTO"}}}}},"deprecated":true}}}}
```

## GET /api/v1/employee/me/{employeeId}/status

> Get's ME status (new content, update, etc)

```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":{"MeStatusDTO":{"type":"object","description":"Current user status: whether there is an unseen personal report.","properties":{"unSeenPersonalReport":{"type":"boolean","description":"Whether the user has an unseen personal report"}}}}},"paths":{"/api/v1/employee/me/{employeeId}/status":{"get":{"tags":["Me (deprecated)"],"description":"Get's ME status (new content, update, etc)","operationId":"getMeStatus","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeStatusDTO"}}}}},"deprecated":true}}}}
```

## GET /api/v1/employee/me/{employeeId}/hi

> Get's the HI resume of the las 30 days

```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":{"MeHIStatusDTO":{"type":"object","description":"HI status for the current user: HI value, period, total votes, distribution, votes by date, question values, valuation.","properties":{"hi":{"type":"number","format":"double"},"periodDays":{"type":"integer","format":"int32"},"totalVotes":{"type":"integer","format":"int32"},"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"votesByDate":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questionValues":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true},"valuation":{"$ref":"#/components/schemas/ValuationType"}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"},"reflectionPrompt":{"type":"string","description":"Reflection prompt, in case the question has an additional comment option enabled"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]}}},"paths":{"/api/v1/employee/me/{employeeId}/hi":{"get":{"tags":["Me (deprecated)"],"description":"Get's the HI resume of the las 30 days","operationId":"getHIStatus","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeHIStatusDTO"}}}}},"deprecated":true}}}}
```

## GET /api/v1/employee/me/{employeeId}/hi/distribution

> Get's the HI votes distribution of the las 30 days

```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":{"MeHIVotesDistributionDTO":{"type":"object","description":"HI votes distribution for the current user: distribution map, question values, total votes, period days.","properties":{"distribution":{"type":"object","additionalProperties":{"type":"integer","format":"int32"}},"questionValues":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValueDTO"},"uniqueItems":true},"totalVotes":{"type":"integer","format":"int32"},"periodDays":{"type":"integer","format":"int32"}}},"QuestionValueDTO":{"type":"object","description":"Option or value for a question (e.g. scale value, choice): id, score, value, image, color.","properties":{"id":{"type":"integer","format":"int32","description":"Value identifier"},"score":{"type":"integer","format":"int32","description":"Numeric score when applicable (e.g. for scales)"},"value":{"type":"string","description":"Display value (label)"},"imageUrl":{"type":"string","description":"URL of the image for this value"},"color":{"type":"string","description":"Color code for this value (e.g. for UI)"},"reflectionPrompt":{"type":"string","description":"Reflection prompt, in case the question has an additional comment option enabled"}}}}},"paths":{"/api/v1/employee/me/{employeeId}/hi/distribution":{"get":{"tags":["Me (deprecated)"],"description":"Get's the HI votes distribution of the las 30 days","operationId":"getHIVotesDistribution","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeHIVotesDistributionDTO"}}}}},"deprecated":true}}}}
```

## GET /api/v1/employee/me/{employeeId}/engagement

> Get's the last engagement details

```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":{"MeEngagementDTO":{"type":"object","description":"Engagement values for the current user: personal, team, and company values and valuations.","properties":{"personalValue":{"type":"number","format":"double"},"personalValuation":{"$ref":"#/components/schemas/ValuationType"},"teamValue":{"type":"number","format":"double"},"teamValuation":{"$ref":"#/components/schemas/ValuationType"},"teamName":{"type":"string"},"companyValue":{"type":"number","format":"double"},"companyName":{"type":"string"},"companyValuation":{"$ref":"#/components/schemas/ValuationType"},"maxValue":{"type":"number","format":"double"},"totalQuestionsCount":{"type":"integer","format":"int32"},"currentQuestionsCount":{"type":"integer","format":"int32"},"outdatedQuestionsCount":{"type":"integer","format":"int32"},"ageQuality":{"$ref":"#/components/schemas/DataQuality"},"amountQuality":{"$ref":"#/components/schemas/DataQuality"}}},"ValuationType":{"type":"string","description":"Valuation of data of a specific field or metric; usually based on the participation of employees in a survey or the number of responses to a question.","enum":["NO_DATA","BAD","WARNING","NEUTRAL","GOOD","EXCELLENT"]},"DataQuality":{"type":"string","description":"Quality of data of a specific field or metric","enum":["NO_DATA","LOW","WARNING","NORMAL","GOOD"]}}},"paths":{"/api/v1/employee/me/{employeeId}/engagement":{"get":{"tags":["Me (deprecated)"],"description":"Get's the last engagement details","operationId":"getMeEngagement","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MeEngagementDTO"}}}}},"deprecated":true}}}}
```

## GET /api/v1/employee/me/{employeeId}/engagement/exists

> Check if user has engagement data

```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":{}},"paths":{"/api/v1/employee/me/{employeeId}/engagement/exists":{"get":{"tags":["Me (deprecated)"],"description":"Check if user has engagement data","operationId":"hasMeEngagementData","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"boolean"}}}}},"deprecated":true}}}}
```
