GET
/
v1
/
score
Get the score of on or multiple candidates
curl --request GET \
  --url https://api.hiringbranch.com/connect/v1/score \
  --header 'X-API-Key: <api-key>'
[
  {
    "candidateId": "59bc377497c7ac0cbc1b69c7",
    "assessmentId": "59bc377497c7ac0cbc1b69c7",
    "assessmentName": "Assessment Name",
    "assessmentStatus": "INVITED",
    "scoreStatus": "PENDING",
    "completion": "1",
    "totalScore": "35",
    "typingSpeed": "85",
    "categoryScores": [
      {
        "name": "Speaking",
        "score": "25"
      }
    ],
    "redFlag": true,
    "started": "2025-01-17T20:39:25.5810000+00:00",
    "finished": "2025-01-17T20:39:25.5810000+00:00"
  }
]

Authorizations

​
X-API-Key
string
header
required

Api key given by Hiringbranch

Headers

​
instance
string

Name of the instance

Query Parameters

​
candidateIds
string

List of candidate ids separated by comma

​
assessmentIds
string

List of assessment ids separated by comma

Response

200
application/json

List of scores and candidates

The response is of type object[].