Skip to main content
GET
Get Assessment

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

Assessment UUID

Response

Successful response

id
string<uuid>
required
target_id
string<uuid>
required
target_name
string | null
required
assessment_type
enum<string>
required
Available options:
black-box,
white-box
assessment_method
enum<string> | null
required
Available options:
balanced,
deep,
ultra,
null
status
enum<string>
required
Available options:
active,
completed,
failed,
canceled
created_at
string<date-time>
required
updated_at
string<date-time>
required
started_at
string<date-time> | null
required
completed_at
string<date-time> | null
required
expected_testing_stages
object[]
required

Target-specific testing stages expected for this assessment. A stage without a matching entry in stages.state has not started yet.

stages
object | null
required

Parsed live stage state used by the dashboard, including each stage's status and customer-safe executor timing.

stage_progress
object[]
required

Canonical merged stage roster for agents. Contains every stage in the current expected plan plus every stage actually observed on this assessment. Use this instead of reconciling expected_testing_stages with stages.state. NOT_STARTED means expected but not yet observed.

failure_reason
string | null

Customer-visible reason recorded for a failed assessment. Null for non-failed assessments or when no reason was recorded.

Maximum string length: 1000