Sign in

v1

latestOpenAPI 3.1.02026-07-24181585937.4 KB
Assessment

assessment.start (Implemented by Partner)

The API for starting an assessment. Implemented by the partner, called by Ashby.

post/assessment.start

Request body

assessment_type_idstring uuid required

The id of the type of assessment to start (retrieved from calling /assessment.list)

Example request

{
  "assessment_type_id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
  "job": {
    "hiringTeam": [
      {
        "email": "test@ashbyhq.com",
        "firstName": "Joey",
        "lastName": "Joe",
        "role": "Hiring Manager",
        "userId": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e"
      }
    ]
  }
}

Response

Responses for the assessment.start endpoint

successboolean required

Example response

{
  "results": {
    "update_request": {
      "assessment_id": "e9ed20fd-d45f-4aad-8a00-a19bfba0083e",
      "timestamp": 1665680638489,
      "assessment_status": {
        "identifier": "result-max",
        "label": "Max Score",
        "description": "The maximum possible score for the assessment",
        "value": 10
      },
      "assessment_profile_url": {
        "identifier": "result-max",
        "label": "Max Score",
        "description": "The maximum possible score for the assessment",
        "value": 10
      },
      "assessment_result": {
        "identifier": "result-max",
        "label": "Max Score",
        "description": "The maximum possible score for the assessment",
        "value": 10
      },
      "cancelled_reason": {
        "identifier": "result-max",
        "label": "Max Score",
        "description": "The maximum possible score for the assessment",
        "value": 10
      },
      "metadata": [
        {
          "identifier": "result-max",
          "label": "Max Score",
          "description": "The maximum possible score for the assessment",
          "value": 10
        }
      ]
    }
  }
}