List assessment orders

๐Ÿ›‘

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).

In order to start evaluating the candidates, you might need to get a list of assessment orders. This task can be performed by using the GET request below

curl -i -H "X-SmartToken: abc123" -X GET https://api.smartrecruiters.com/v1/assessments?limit=20&offset=0&status=NEW

Response Body:

{
    "limit": 10,
    "offset": 0,
    "totalFound": 2,
    "content": [
        {
            "id": "511a3942300469a9c33819d8",
            "status": "NEW",
            "createDate": "2013-03-07T13:34:40.135+0000",
            "lastUpdateDate": "2013-03-07T13:34:40.135+0000",
            "requestor": {
                "firstName": "Rob",
                "lastName": "Kaman",
                "email": "[email protected]",
                "phone": "(415) 111-2222"
            },
            "candidate": {
                "id": "e63dfcab300260b2591f585126ede56627db4ef8",
                "firstName": "Zoe",
                "lastName": "Temple",
                "email": "[email protected]",
                "phone": "(415) 111-2222",
                "addressLine": "56 Tehama Street, San Francisco, CA 94105 "
            },
            "job": {
                "id": "e63dfcab300260b2591f585126ede56627db4321",
                "name": "Senior Java Developer",
                "industry": {
                    "id": "computer_software",
                    "label": "Computer Software"
                },
                "function": {
                    "id": "engineering",
                    "label": "Engineering"
                },
                "experienceLevel": {
                    "id": "mid_senior_level",
                    "label": "senior"
                },
                "location": {
                    "country": "US",
                    "region": "CA",
                    "city": "San Francisco"
                }
            },
            "company": {
                "id": "511a3942300469a9c3381ba3",
                "name": "Orlando Magic Inc."
            },
            "offer": {
                "catalogId": "aaa-123-bbb",
                "name": "Senior Java Developer Skill Test"
            }
        },
        {
            "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": "e63dfcab300260b2591f585126ede56627db4321",
                "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": "511a3942300469a9c33811d1",
                "name": "Orlando Magic Inc."
            },
            "offer": {
                "catalogId": "bbb-444-111",
                "name": "Senior Ruby Developer Skill Test"
            }
        }
    ]
}

The response body will contain a ListResult object containing AssessmentOrder objects. This list can then be filtered by status and the date created. For more details on filtering and response and request settings, please check /assessments list method.