Scores

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

Retrieves a list of all available scores on your account

get

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

Authorizations

happyforceAPIKey

happyforceAPIKeystringRequired

API Key for Happyforce API

Responses

200

OK

*/*

Self contained model that contains the metadata for a given score

idstringOptional

Id of the score

Example: 64f8a0e2d5b7c9a1e3f4a5b6

statusstring · enumOptional

Which is the status for a given score

Possible values:

namestringOptional

Title of the score

descriptionstringOptional

Description of the score

get

/api/v1/public/company/scores

HTTPcURLJavaScriptPython

GET /api/v1/public/company/scores HTTP/1.1
Host: api.happyforce.com
happyforceAPIKey: YOUR_API_KEY
Accept: */*

200

OK

[
  {
    "id": "64f8a0e2d5b7c9a1e3f4a5b6",
    "status": "ACTIVATED",
    "name": "text",
    "description": "text",
    "factors": [
      {
        "id": "64f8a0e2d5b7c9a1e3f4a5b6",
        "name": "text",
        "description": "text",
        "questions": [
          {
            "id": "64f8a0e2d5b7c9a1e3f4a5b6",
            "title": "text"
          }
        ]
      }
    ]
  }
]