Skip to main content
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

List of scores and candidates

​
candidateId
string
required

Candidate id

Minimum string length: 1
Example:

"59bc377497c7ac0cbc1b69c7"

​
assessmentId
string
required

Assessment id

Minimum string length: 1
Example:

"59bc377497c7ac0cbc1b69c7"

​
assessmentName
string
required

Assessment name

Minimum string length: 1
Example:

"Assessment Name"

​
assessmentStatus
enum<string>
required

Assessment status

Available options:
INVITED,
IN_PROGRESS,
COMPLETED
​
scoreStatus
enum<string>
required

Score status

Available options:
PENDING,
LOW_PASS,
PASS,
FAIL
​
completion
string
required

Completion in percentage

Minimum string length: 1
Example:

"1"

​
totalScore
string
required

Total score in percentage

Minimum string length: 1
Example:

"35"

​
typingSpeed
string
required

Typing Speed in words per minute

Minimum string length: 1
Example:

"85"

​
categoryScores
object[]
required

List of category scores

​
redFlag
boolean
required

Candidate's proctoring report contains a red flag

Example:

true

​
started
string
required

Date time of the beginning of the assessment

Minimum string length: 1
Example:

"2025-01-17T20:39:25.5810000+00:00"

​
finished
string
required

Date time of the end of the assessment

Minimum string length: 1
Example:

"2025-01-17T20:39:25.5810000+00:00"