> ## Documentation Index
> Fetch the complete documentation index at: https://docs.braintest.ir/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Test Record Details

> Retrieve a single test record's metadata, including nested test configuration and linked participant profile.

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

```http theme={"dark"}
GET https://braintest.ir/api/v2/record/{token}
```

## Headers

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

## Path parameters

<ParamField path="token" type="string" required>
  The UUID token of the test record.
</ParamField>

## Response

<ResponseField name="data" type="object">
  <ResponseField name="token" type="string">
    Record UUID.
  </ResponseField>

  <ResponseField name="status" type="integer">
    Record status: `0` (VIP wait), `1` (finished), or `2` (ready).
  </ResponseField>

  <ResponseField name="auth_required" type="boolean">
    `true` if a profile must be authenticated before the test can proceed.
  </ResponseField>

  <ResponseField name="tests_auth_required" type="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.
  </ResponseField>

  <ResponseField name="is_finished" type="boolean">
    `true` if the test is completed and results are available.
  </ResponseField>

  <ResponseField name="test" type="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
  </ResponseField>

  <ResponseField name="profile" type="object | null">
    Linked participant profile, or `null` if not yet authenticated.
  </ResponseField>
</ResponseField>

## Example request

```bash theme={"dark"}
curl -X GET "https://braintest.ir/api/v2/record/a1b2c3d4-e5f6-7890-abcd-ef1234567890" \
  -H "API-KEY: YOUR_API_KEY"
```

## Example response

```json theme={"dark"}
{
  "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": []
}
```