Get Test Record Details

Use this endpoint to fetch detailed information about a specific test record. The response includes the record’s current status, authentication requirements, nested test configuration, and the linked participant profile if one exists.

Endpoint

GET https://braintest.ir/api/v2/record/{token}

Headers

Header	Value
`API-KEY`	Your API key from the organizer panel

Path parameters

string

required

The UUID token of the test record.

Response

object

string

Record UUID.

integer

Record status: 0 (VIP wait), 1 (finished), or 2 (ready).

boolean

true if a profile must be authenticated before the test can proceed.

boolean

Organizer policy for the authentication flow. true (default) means POST /record/{token}/auth/ will send an SMS code and return a draft_token that you complete with PUT /record/{token}/auth/verify/. false means authentication completes instantly on the first call.

boolean

true if the test is completed and results are available.

object

Nested test configuration:

id (string): Test identifier, for example MCMI or NEO
min_age (integer): Minimum participant age in years
max_age (integer): Maximum participant age in years
gender_permission (string): Allowed gender values
title (string): Human-readable test title
questions_count (integer): Number of questions in the test
doing_time_minutes (integer): Recommended test duration
categories (array): Test category metadata

object | null

Linked participant profile, or null if not yet authenticated.

Example request

curl -X GET "https://braintest.ir/api/v2/record/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "API-KEY: YOUR_API_KEY"

Example response

{
  "data": {
    "token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "status": 2,
    "auth_required": true,
    "tests_auth_required": true,
    "is_finished": false,
    "test": {
      "id": "MCMI",
      "min_age": 18,
      "max_age": 99,
      "gender_permission": "both",
      "title": "Millon Clinical Multiaxial Inventory",
      "questions_count": 175,
      "doing_time_minutes": 30,
      "categories": [
        { "id": "clinical", "title": "Clinical Personality Patterns" }
      ]
    },
    "profile": null
  },
  "successful": true,
  "messages": []
}

Overview

Connection

Records

Roadmaps

Endpoint

Headers

Path parameters

Response

Example request

Example response

​Endpoint

​Headers

​Path parameters

​Response

​Example request

​Example response

Endpoint

Headers

Path parameters

Response

Example request

Example response