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

# Scores Resource

## PUT /api/v1/company/scores/{scoreId}/deactivate

>

```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":{"ScoreDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconPath":{"type":"string"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorDTO"},"uniqueItems":true},"schedule":{"type":"string","enum":["MONTHLY","BIMONTHLY","QUARTERLY","FOURMONTHLY","BIANNUAL","YEARLY"]},"lastMeasure":{"type":"string","format":"date-time"},"nextMeasure":{"type":"string","format":"date-time"},"measuringNow":{"type":"boolean"},"numberMeasurements":{"type":"integer","format":"int32"},"derived":{"type":"boolean"}}},"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"]},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreFactorDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortName":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"longDescription":{"$ref":"#/components/schemas/MultiLanguage"},"reason":{"$ref":"#/components/schemas/MultiLanguage"},"reasonTitle":{"$ref":"#/components/schemas/MultiLanguage"},"reasonDescription":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionDTO"}}}},"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}},"paths":{"/api/v1/company/scores/{scoreId}/deactivate":{"put":{"tags":["scores-resource"],"operationId":"deactivateScore","parameters":[{"name":"scoreId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ScoreDTO"}}}}}}}}}
```

## PUT /api/v1/company/scores/{scoreId}/activate

>

```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":{"ScoreDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconPath":{"type":"string"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorDTO"},"uniqueItems":true},"schedule":{"type":"string","enum":["MONTHLY","BIMONTHLY","QUARTERLY","FOURMONTHLY","BIANNUAL","YEARLY"]},"lastMeasure":{"type":"string","format":"date-time"},"nextMeasure":{"type":"string","format":"date-time"},"measuringNow":{"type":"boolean"},"numberMeasurements":{"type":"integer","format":"int32"},"derived":{"type":"boolean"}}},"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"]},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreFactorDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortName":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"longDescription":{"$ref":"#/components/schemas/MultiLanguage"},"reason":{"$ref":"#/components/schemas/MultiLanguage"},"reasonTitle":{"$ref":"#/components/schemas/MultiLanguage"},"reasonDescription":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionDTO"}}}},"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}},"paths":{"/api/v1/company/scores/{scoreId}/activate":{"put":{"tags":["scores-resource"],"operationId":"activateScore","parameters":[{"name":"scoreId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ScoreDTO"}}}}}}}}}
```

## GET /api/v1/company/scores

>

```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":{"ScoresModel":{"type":"string","description":"Score model to use (CORE or DERIVED)","enum":["CORE","DERIVED"]},"ScoreDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconPath":{"type":"string"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorDTO"},"uniqueItems":true},"schedule":{"type":"string","enum":["MONTHLY","BIMONTHLY","QUARTERLY","FOURMONTHLY","BIANNUAL","YEARLY"]},"lastMeasure":{"type":"string","format":"date-time"},"nextMeasure":{"type":"string","format":"date-time"},"measuringNow":{"type":"boolean"},"numberMeasurements":{"type":"integer","format":"int32"},"derived":{"type":"boolean"}}},"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"]},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreFactorDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortName":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"longDescription":{"$ref":"#/components/schemas/MultiLanguage"},"reason":{"$ref":"#/components/schemas/MultiLanguage"},"reasonTitle":{"$ref":"#/components/schemas/MultiLanguage"},"reasonDescription":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionDTO"}}}},"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}},"paths":{"/api/v1/company/scores":{"get":{"tags":["scores-resource"],"operationId":"getCompanyScores","parameters":[{"name":"model","in":"query","required":false,"schema":{"$ref":"#/components/schemas/ScoresModel","default":"CORE"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ScoreDTO"}}}}}}}}}}
```

## GET /api/v1/company/scores/{scoreId}

>

```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":{"ScoreDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"iconPath":{"type":"string"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"shortDescription":{"$ref":"#/components/schemas/MultiLanguage"},"status":{"$ref":"#/components/schemas/ScoreStatuses"},"factors":{"type":"array","items":{"$ref":"#/components/schemas/ScoreFactorDTO"},"uniqueItems":true},"schedule":{"type":"string","enum":["MONTHLY","BIMONTHLY","QUARTERLY","FOURMONTHLY","BIANNUAL","YEARLY"]},"lastMeasure":{"type":"string","format":"date-time"},"nextMeasure":{"type":"string","format":"date-time"},"measuringNow":{"type":"boolean"},"numberMeasurements":{"type":"integer","format":"int32"},"derived":{"type":"boolean"}}},"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"]},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreFactorDTO":{"type":"object","properties":{"id":{"type":"string"},"name":{"$ref":"#/components/schemas/MultiLanguage"},"shortName":{"$ref":"#/components/schemas/MultiLanguage"},"description":{"$ref":"#/components/schemas/MultiLanguage"},"longDescription":{"$ref":"#/components/schemas/MultiLanguage"},"reason":{"$ref":"#/components/schemas/MultiLanguage"},"reasonTitle":{"$ref":"#/components/schemas/MultiLanguage"},"reasonDescription":{"$ref":"#/components/schemas/MultiLanguage"},"questions":{"type":"array","items":{"$ref":"#/components/schemas/ScoreQuestionDTO"}}}},"ScoreQuestionDTO":{"type":"object","properties":{"id":{"type":"string"},"type":{"$ref":"#/components/schemas/QuestionType"},"title":{"$ref":"#/components/schemas/MultiLanguage"},"first":{"$ref":"#/components/schemas/QuestionValue"},"last":{"$ref":"#/components/schemas/QuestionValue"},"inverted":{"type":"boolean"},"values":{"type":"array","items":{"$ref":"#/components/schemas/QuestionValue"}}}},"QuestionType":{"type":"string","description":"Type of question used in company surveys or questionnaires","enum":["GENERAL","TOPIC","OPEN","RANGE"]},"QuestionValue":{"type":"object","properties":{"id":{"type":"integer","format":"int32"},"score":{"type":"integer","format":"int32"},"label":{"$ref":"#/components/schemas/MultiLanguage"},"imageUrl":{"type":"string"},"color":{"type":"string"}},"required":["id","label","score"]}}},"paths":{"/api/v1/company/scores/{scoreId}":{"get":{"tags":["scores-resource"],"operationId":"getScore","parameters":[{"name":"scoreId","in":"path","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ScoreDTO"}}}}}}}}}
```

## GET /api/v1/company/scores/export

>

```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"}}},"paths":{"/api/v1/company/scores/export":{"get":{"tags":["scores-resource"],"operationId":"downloadFile","responses":{"200":{"description":"OK","content":{"application/vnd.openxmlformats-officedocument.spreadsheetml.sheet":{"schema":{"type":"string","format":"binary"}},"*/*":{"schema":{"type":"string","format":"binary"}}}}}}}}}
```
