Get an assessment order

🛑
Assessment API Sunset
This API has been deprecated since September 4, 2023. The sunset date is May 10, 2024. If you are an assessment provider or looking to build an assessment integration with SmartRecruiters, please consider using the new Assessment API (2021).

Description

Enables you to get assessment order details. This operation requires passing the assessment order ID as part of the request parameter.

Request

GET https://api.smartrecruiters.com/v1/assessments/{assessmentOrderId}

Path Parameters

Name	Type	Description
assessmentOrderId	string	unique id of an assessment order

Query Parameters

n/a

Request Body

n/a

Response Body

An instance of AssessmentOrder

Example request

curl -i
     -H "X-SmartToken: abc123"
     -X GET
     https://api.smartrecruiters.com/v1/assessments/511a3942300469a9c33819d8

Example response

{
    "id": "511a3942300469a9c33819d1",
    "status": "NEW",
    "createDate": "2013-03-07T13:34:40.137+0000",
    "lastUpdateDate": "2013-03-07T13:34:40.137+0000",
    "requestor": {
        "firstName": "Rob",
        "lastName": "Kaman",
        "email": "[email protected]",
        "phone": "(415) 111-2222"
    },
    "candidate": {
        "id": "e63dfcab300260b2591f585126ede56627db4ef8",
        "firstName": "Mark",
        "lastName": "Hunt",
        "email": "[email protected]",
        "phone": "(415) 111-2222",
        "addressLine": "409 North Magnolia Avenue, Orlando, FL 32801, United States"
    },
    "job": {
        "id": "e63dfcab300260b2591f585126ede56627db4ef8",
        "name": "Senior Ruby Developer",
        "industry": {
            "id": "computer_software",
            "label": "Computer Software"
        },
        "function": {
            "id": "engineering",
            "label": "Engineering"
        },
        "experienceLevel": {
            "id": "mid_senior_level",
            "label": "senior"
        },
        "location": {
            "country": "US",
            "region": "FL",
            "city": "Orlando"
        }
    },
    "company": {
        "id": "511a3942300469a9c33819d1",
        "name": "Orlando Magic Inc."
    },
    "offer": {
        "catalogId": "bbb-444-111",
        "name": "Senior Ruby Developer Skill Test"
    }
}