# Scores

Convenience methods for retrieve the active scores of your company in Happyforce

## Retrieves a list of all available scores on your account

> The information provided by this endpoint is useful to build the filters on the score Stats API

```json
{"openapi":"3.1.0","info":{"title":"Happyforce API","version":"v1"},"tags":[{"name":"Scores","description":"Convenience methods for retrieve the active scores of your company in Happyforce"}],"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":[{"happyforceAPIKey":[]}],"components":{"securitySchemes":{"happyforceAPIKey":{"type":"apiKey","description":"API Key for Happyforce API","name":"happyforceAPIKey","in":"header"}},"schemas":{"Score":{"type":"object","description":"Self contained model that contains the metadata for a given score","properties":{"id":{"type":"string","description":"Id of the score"},"status":{"$ref":"#/components/schemas/ScoreStatuses","description":"Which is the status for a given score"},"name":{"type":"string","description":"Title of the score"},"description":{"type":"string","description":"Description of the score"},"factors":{"type":"array","description":"Factors that compose this score","items":{"$ref":"#/components/schemas/ScoreFactor"},"uniqueItems":true}}},"ScoreStatuses":{"type":"string","description":"Status of a score in the company (ACTIVATED or DISABLED)","enum":["ACTIVATED","DISABLED"]},"ScoreFactor":{"type":"object","description":"Self contained model that contains the metadata for a given factor","properties":{"id":{"type":"string","description":"Id of the factor"},"name":{"type":"string","description":"Title of the factor"},"description":{"type":"string","description":"Description of the factor"},"questions":{"type":"array","description":"Questions that compose this factor","items":{"$ref":"#/components/schemas/ScoreQuestion"},"uniqueItems":true}}},"ScoreQuestion":{"type":"object","description":"Self contained model that contains the metadata for a given question","properties":{"id":{"type":"string","description":"Id of the question"},"title":{"type":"string","description":"Title of the question"}}}}},"paths":{"/api/v1/public/company/scores":{"get":{"tags":["Scores"],"summary":"Retrieves a list of all available scores on your account","description":"The information provided by this endpoint is useful to build the filters on the score Stats API","operationId":"getCompanyScoreStats_2","responses":{"200":{"description":"OK","content":{"*/*":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Score"}}}}}}}}}}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api-docs.myhappyforce.com/docs/api-reference/scores.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.