List Test Records

Use this endpoint to retrieve a paginated list of test records associated with your organizer account. You can filter by completion status, test type, and profile attributes to locate specific records quickly.

Endpoint

GET https://braintest.ir/api/v2/record/

Headers

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

Query parameters

string

Free-text search across record metadata.

integer

default:"1"

Page number for pagination. Each page contains 30 items.

boolean

Filter by completion status. true returns finished records only.

string

Filter by test identifier, for example MCMI, NEO, DASS-21, or PHQ-9.

boolean

Filter by participant gender. true for male, false for female.

string

Filter by profile UUID token.

integer

Filter by your own external identifier assigned during profile creation.

Response

object

integer

Total number of records matching the filters.

string | null

URL for the next page, or null if there is no next page.

string | null

URL for the previous page, or null if there is no previous page.

array

Array of record objects. Each record includes token, status, auth_required, tests_auth_required, is_finished, test, and profile.

object

Summary of available filter options and applied filters.

Example request

curl -X GET "https://braintest.ir/api/v2/record/?page=1&filter__is_finished=false&filter__test__id=MCMI" \
  -H "API-KEY: YOUR_API_KEY"

Example response

{
  "data": {
    "count": 42,
    "next": "https://braintest.ir/api/v2/record/?page=2&filter__is_finished=false&filter__test__id=MCMI",
    "previous": null,
    "results": [
      {
        "token": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "status": 2,
        "auth_required": true,
        "tests_auth_required": true,
        "is_finished": false,
        "test": {
          "id": "MCMI",
          "title": "Millon Clinical Multiaxial Inventory"
        },
        "profile": null
      }
    ],
    "records_filter": {
      "is_finished": false,
      "test__id": "MCMI"
    }
  },
  "successful": true,
  "messages": []
}

Overview

Connection

Records

Roadmaps

Endpoint

Headers

Query parameters

Response

Example request

Example response

​Endpoint

​Headers

​Query parameters

​Response

​Example request

​Example response

Endpoint

Headers

Query parameters

Response

Example request

Example response