Sign in
assessment

Get Assessments

Get all assessments.

get/api/v1/assessment/

Request

  • The document declares no server URL.
  • Auth: OAuth 2 (password, token URL /api/v1/auth/token)

Query parameters

offsetinteger
limitinteger
sort_order'asc' | 'desc' nullable
namestring nullable
assessment_typeAssessmentType[] nullable
sort_by'name' | 'assessment_type' | 'description' nullable

Response

Successful Response

totalinteger required
pageinteger required
sizeinteger required
pagesinteger required

Example response

{
  "items": [
    {
      "assessment_type": "PurpleTeam",
      "default_evaluation_templates": [
        {
          "evaluation_template_id": "00000000-0000-0000-0000-000000000000",
          "position": 0
        }
      ],
      "description": "Atomic based Purple Team engagement",
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "Purple Team Assessment Example"
    }
  ]
}

Changes

No recorded changes to this operation across all 4 revisions of this API.