Skip to content

Get status

Returns the current status and available result data for a candidate assessment.

GEThttps://app.smalltalk2.me/api/integration/test_status

Query parameters

ParameterTypeRequiredDescription
idstringrequiredinterview_id returned by send_test.
additional_fieldsstringoptionalComma-separated names of additional report fields to return.

Available additional_fields values:

  • detailed_scores
  • strength_weaknesses
  • problem_statuses
  • problem_titles
  • proctoring_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

PropertyTypeAvailabilityDescription
statusstringalwaysCurrent assessment state.
expiration_timestampstringdocumentedTime when the assessment expires.
started_timestampstringdocumentedTime when the candidate started the assessment.
finished_timestampstringdocumentedTime when the candidate finished the assessment.
report_urlstringcompleted assessmentURL to the candidate's SmallTalk report page.
scorestringcompleted assessmentCandidate performance score.
additional_fieldsobjectwhen requestedRequested rich result data.
audio_recordingsstring[]documentedLinks to the candidate's audio recordings.

Timestamps use UTC, for example:

text
2009-11-10T23:00:00Z

Status values

ValueMeaning
completedThe assessment is completed.
expiredThe assessment link has expired and is no longer available.
failedSomething went wrong; the source notes that this is most often caused by a bad email address.
processingThe report is not ready.
canceledThe 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
  }
}

SmallTalk2Me documentation