Skip to main content
GET
/
v1
/
assessments
/
{assessment_id}
Get Assessment
curl --request GET \
  --url https://api.mindfort.app/v1/assessments/{assessment_id} \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.mindfort.app/v1/assessments/{assessment_id}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.mindfort.app/v1/assessments/{assessment_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://api.mindfort.app/v1/assessments/{assessment_id}"

req, _ := http.NewRequest("GET", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target_name": "<string>",
  "started_at": "2023-11-07T05:31:56Z",
  "completed_at": "2023-11-07T05:31:56Z"
}
{
"error": "<string>",
"request_id": "<string>"
}
{
"error": "<string>",
"request_id": "<string>"
}
{
"error": "<string>",
"request_id": "<string>"
}
{
"error": "<string>",
"request_id": "<string>"
}
{
"error": "<string>",
"request_id": "<string>"
}

Authorizations

Authorization
string
header
required

API key generated from the MindFort dashboard. Pass as Authorization: Bearer <your-api-key>.

Path Parameters

assessment_id
string<uuid>
required

UUID of the assessment

Response

Assessment returned successfully

Assessment fields returned by the assessments list endpoint. Internal workflow, plan, and session fields are not included.

id
string<uuid>

UUID of the assessment

target_id
string<uuid>

UUID of the assessed target

target_name
string

Name of the assessed target

assessment_type
enum<string>

Assessment type. white-box includes code assessment; black-box does not.

Available options:
black-box,
white-box
assessment_method
enum<string>

API assessment method. Dashboard labels map as turbo = Balanced, balanced = Deep, and deep = Ultra.

Available options:
turbo,
balanced,
deep
status
enum<string>

Normalized assessment status

Available options:
active,
completed,
failed,
canceled
started_at
string<date-time> | null

Assessment start timestamp

completed_at
string<date-time> | null

Assessment completion timestamp