Skip to main content
GET
/
v1
/
assessments
List Assessments
curl --request GET \
  --url https://api.mindfort.app/v1/assessments \
  --header 'Authorization: Bearer <token>'
{
  "assessments": [
    {
      "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"
    }
  ],
  "pagination": {
    "limit": 123,
    "has_more": true,
    "next_cursor": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
target_id
string<uuid>

Filter by target UUID

​
assessment_type
enum<string>

Filter by assessment type. white-box returns assessments that include code assessment; black-box returns assessments that do not.

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

Filter by assessment method

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

Filter by normalized assessment status

Available options:
active,
completed,
failed,
canceled
​
order_by
enum<string>
default:created_at

Sort field for cursor pagination

Available options:
created_at,
updated_at
​
order_direction
enum<string>
default:desc

Sort direction for cursor pagination

Available options:
asc,
desc
​
limit
integer
default:25

Maximum number of assessments to return

Required range: 1 <= x <= 100
​
cursor
string

Opaque cursor from pagination.next_cursor

Response

Assessments returned successfully

​
assessments
object[]
​
pagination
object