Get status
Returns the current status and available result data for a candidate assessment.
GET
https://app.smalltalk2.me/api/integration/test_statusQuery parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
id | string | required | interview_id returned by send_test. |
additional_fields | string | optional | Comma-separated names of additional report fields to return. |
Available additional_fields values:
detailed_scoresstrength_weaknessesproblem_statusesproblem_titlesproctoring_artifacts
See Additional fields for their response shapes.
Example request
bash
curl 'https://app.smalltalk2.me/api/integration/test_status?id=o2jn3r&additional_fields=strength_weaknesses' \
-H 'Authorization: Bearer <token>'Response
| Property | Type | Availability | Description |
|---|---|---|---|
status | string | always | Current assessment state. |
expiration_timestamp | string | documented | Time when the assessment expires. |
started_timestamp | string | documented | Time when the candidate started the assessment. |
finished_timestamp | string | documented | Time when the candidate finished the assessment. |
report_url | string | completed assessment | URL to the candidate's SmallTalk report page. |
score | string | completed assessment | Candidate performance score. |
additional_fields | object | when requested | Requested rich result data. |
audio_recordings | string[] | documented | Links to the candidate's audio recordings. |
Timestamps use UTC, for example:
text
2009-11-10T23:00:00ZStatus values
| Value | Meaning |
|---|---|
completed | The assessment is completed. |
expired | The assessment link has expired and is no longer available. |
failed | Something went wrong; the source notes that this is most often caused by a bad email address. |
processing | The report is not ready. |
canceled | The organization canceled the report. |
Completion status discrepancy
The source status table lists completed, but its JSON example uses complete, and the conditional response fields are described as available when status is complete. Confirm the live value before implementing an exact string match; defensive integrations should be prepared to handle both until the contract is clarified.
Example response
json
{
"status": "complete",
"started_timestamp": "2009-11-10T23:00:00Z",
"finished_timestamp": "2009-11-10T23:00:00Z",
"report_url": "https://app.smalltalk2.me/report/o3rjgn",
"score": "B2",
"additional_fields": {
"strength_weaknesses": {
"strengths": [
"strength1",
"strength2"
],
"weaknesses": [
"weakness1",
"weakness2"
]
},
"detailed_scores": null,
"smalltalk_score": 71
}
}