List incidents with associated components for the incident register

GET

/v1/incidents

• Production
• Staging
• Local

Parameters

Query Parameters

id

array | null

title_contains

string | null

description_contains

string | null

free_text

string | null

id_contains

string | null

severity

array | null

status

array | null

Allowed values: New In Progress Review Closed

source

array | null

assigned_to

array | null

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

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

detected_after

string | null format: date-time

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

Example

2026-01-01T00:00:00Z

detected_before

string | null format: date-time

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

Example

2026-12-31T23:59:59Z

occurred_after

string | null format: date-time

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

Example

2026-01-01T00:00:00Z

occurred_before

string | null format: date-time

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

Example

2026-12-31T23:59:59Z

occurred_is_null

boolean | null

Match only incidents whose occurred_date is unset. Mutually exclusive with occurred_after/occurred_before.

responded_after

string | null format: date-time

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

Example

2026-01-01T00:00:00Z

responded_before

string | null format: date-time

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

Example

2026-12-31T23:59:59Z

responded_is_null

boolean | null

Match only incidents whose responded_date is unset. Mutually exclusive with responded_after/responded_before.

contained_after

string | null format: date-time

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

Example

2026-01-01T00:00:00Z

contained_before

string | null format: date-time

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

Example

2026-12-31T23:59:59Z

contained_is_null

boolean | null

Match only incidents whose contained_date is unset. Mutually exclusive with contained_after/contained_before.

opened_by

array | null

updated_by

array | null

tags

array | null

include_children

boolean | null

When true, the list includes incidents that are linked under another incident (i.e. rows with a non-null parent_id). Defaults to false so registers and rollups stay collapsed.

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.

order_by

string | null

Responses

200

List incidents

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 an Incident. An Incident plus the relational data shown on the incident register: risk associations, threat objectives, tags, and comment count.

object

comment_count

required

integer format: int64

incident

required

Relationship, core incident information

object

assigned_to

One of:

null

null

object

A User as returned by the API.

Profile images are not embedded — clients fetch them from GET /api/v1/{icon} when icon is Some.

object

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

id

required

string format: uuid

last_name

required

string

contained_date

string | null format: date-time

created_date

required

string format: date-time

description

required

string

detected_date

required

string format: date-time

id

required

string

Example

INC-00001

occurred_date

string | null format: date-time

opened_by

required

A User as returned by the API.

Profile images are not embedded — clients fetch them from GET /api/v1/{icon} when icon is Some.

object

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

id

required

string format: uuid

last_name

required

string

parent_id

When set, this incident is linked under the named parent incident.

string | null

Example

INC-00001

responded_date

string | null format: date-time

severity

One of:

null

null

string

string

Allowed values: SEV-5 SEV-4 SEV-3 SEV-2 SEV-1

severity_reasoning

string | null

source

required

Where the incident was reported from (e.g. “Employee Reported”). Always present.

string

status

required

The status of an incident

string

Allowed values: New In Progress Review Closed

title

required

string

updated_by

required

A User as returned by the API.

Profile images are not embedded — clients fetch them from GET /api/v1/{icon} when icon is Some.

object

email

required

string

first_name

required

string

icon

Relative path to the user’s avatar endpoint, e.g. "users/{id}/avatar?v={hash}". None when the user has no avatar.

string | null

id

required

string format: uuid

last_name

required

string

updated_date

required

string format: date-time

linked_children_count

required

Number of incidents linked under this incident (i.e. children pointing at it). An incident is itself a linked child when incident.parent_id is set.

integer format: int64

risk_associations

required

Array<string>

tags

required

Array<object>

object

content

required

string

creator_id

required

string format: uuid

id

required

string format: uuid

org_id

string | null format: uuid

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

null

string

The relevancy of the threat objective to the risk. Typically a value of 1, or 2. While the relevancy is null the the database, implementations of retrieving this from postgres should ignore null values.

string

Allowed values: Moderate Substantial

threat_objective

required

The threat objective type

string

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