Skip to content

List all AKRs (Adversarial Key Risks).

GET
/v1/risks/akr
id
Array<integer>
title_contains
string | null
description_contains
string | null
free_text_contains
string | null
id_contains
string | null
status
array | null
Allowed values: New Urgency Proposed Remediation Closure Proposed Closed
likelihood
array | null
impact
array | null
urgency
array | null
source
array | null
threat_objectives
array | null
created_after
string | null format: date-time

Inclusive lower bound on created_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-01-01T00:00:00Z
created_before
string | null format: date-time

Inclusive upper bound on created_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-12-31T23:59:59Z
updated_after
string | null format: date-time

Inclusive lower bound on updated_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-01-01T00:00:00Z
updated_before
string | null format: date-time

Inclusive upper bound on updated_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-12-31T23:59:59Z
discovered_after
string | null format: date-time

Inclusive lower bound on discovered_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-01-01T00:00:00Z
discovered_before
string | null format: date-time

Inclusive upper bound on discovered_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-12-31T23:59:59Z
due_after
string | null format: date-time

Inclusive lower bound on due_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-01-01T00:00:00Z
due_before
string | null format: date-time

Inclusive upper bound on due_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-12-31T23:59:59Z
due_is_null
boolean | null

Match only AKRs whose due_date is unset. Mutually exclusive with due_after/due_before.

expected_after
string | null format: date-time

Inclusive lower bound on expected_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-01-01T00:00:00Z
expected_before
string | null format: date-time

Inclusive upper bound on expected_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-12-31T23:59:59Z
expected_is_null
boolean | null

Match only AKRs whose expected_date is unset. Mutually exclusive with expected_after/expected_before.

closed_after
string | null format: date-time

Inclusive lower bound on closed_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-01-01T00:00:00Z
closed_before
string | null format: date-time

Inclusive upper bound on closed_date. RFC 3339 or bare YYYY-MM-DD.

Example
2026-12-31T23:59:59Z
closed_is_null
boolean | null

Match only AKRs whose closed_date is unset. Mutually exclusive with closed_after/closed_before.

assigned_to
array | null

Accepts UUIDs, the literal null (unassigned), and the sentinel me (the calling user, resolved server-side). Multiple values union.

overdue
boolean | null

Filter to overdue (true) or non-overdue (false) AKRs. Overdue means open and past due_date.

order_by
string | null
page
integer format: int64
default: 1 >= 1 <= 1000000

1-indexed page number. Defaults to 1 (explicit null reads as the default); zero is rejected.

page_size
integer format: int64
default: 50 >= 1 <= 500

Rows per page. Defaults to 50 (explicit null reads as the default); zero is rejected.

List AKRs with register-context fields

Paginated list envelope: { "results": [...], "pagination": {...} }.

object
pagination
required

Pagination metadata describing the slice.

object
page
required

1-indexed page number of this result slice.

integer format: int64
page_size
required

Number of items requested per page.

integer format: int64
total_items
required

Total number of matching items across all pages.

integer format: int64
total_pages
required

Total number of pages at this page size.

integer format: int64
results
required

The items on this page.

Array<object>

Register row for Adversarial Key Risks (AKRs). A KeyRisk plus the relational data shown on the AKR register: threat objectives, incident associations, and comment count. AKRs cannot be tagged.

object
comments
required
integer format: int64
incident_associations
required
Array<string>
Example
INC-00001
key_risk
required

The core view of an Adversarial Key Risk (AKR).

Relational data — threat objectives, comments, and incident associations — is exposed on KeyRiskRegisterEntry, not here.

object
assigned_to
One of:
null
closed_date
string | null format: date-time
control_statement
string | null
created_date
required
string format: date-time
description
required
string
discovered_date
required
string format: date-time
due_date
string | null format: date-time
expected_date
string | null format: date-time
id
required
string
Example
AKR-00001
impact
One of:
null
likelihood
One of:
null
remediation_task
string | null
status
required

The status of a risk

string
Allowed values: New Urgency Proposed Remediation Closure Proposed Closed
title
required
string
type
required
string
Allowed values: Code Configuration Control Deficiency Policy Procedural Vulnerability Third-party
updated_date
required
string format: date-time
urgency
One of:
null
threat_objectives
required
Array<object>

A relational struct that has a threat objective type and its relevancy to a risk.

PartialEq, Eq, and Hash are implemented manually to exclude created_date, which is metadata about when the relation was mutated — not part of the identity.

object
created_date

The time that this relation was mutated

string | null format: date-time
relevance
One of:
null
threat_objective
required

The threat objective type

string
Allowed values: Sabotage Data Disclosure Extortion Customer Targeting Resource Hijacking Fraud