Get an incident by ID
GET /v1/incidents/{id}
Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”The ID of the incident to retrieve
Example
123Responses
Section titled “ Responses ”Get the incident
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
Relationship, core incident information
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
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
Example
INC-00001A User as returned by the API.
Profile images are not embedded — clients fetch them from
GET /api/v1/{icon} when icon is Some.
object
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
The status of an incident
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
Relative path to the user’s avatar endpoint, e.g.
"users/{id}/avatar?v={hash}". None when the user has no avatar.
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
The time that this relation was mutated
The threat objective type
Incident not found