Get the history of changes for a risk

GET

/v1/risks/{id}/history

const url = 'https://api.adversarial.com/api/v1/risks/RSK-00001/history?page=1&page_size=100';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.adversarial.com/api/v1/risks/RSK-00001/history?page=1&page_size=100'

Parameters

Path Parameters

required

string

The ID of the risk — RSK-00001 (case-insensitive) or a bare number

Example

RSK-00001

Query Parameters

page

integer format: int64

default: 1 >= 1 <= 1000000

1-indexed page number. Defaults to 1; zero is rejected.

page_size

integer format: int64

default: 100 >= 1 <= 500

Rows per page. Defaults to 100, max 500; zero is rejected.

Responses

200

List the risk history

application/json

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>

A single entry in the history list, representing a set of simultaneous changes to an item

object

changes

required

Array

One of:

A text or single-choice field, such as status, severity, or title.

object

field

required

string

kind

required

string

Allowed values: text

new

string | null

old

string | null

A user-assignment field.

object

field

required

string

kind

required

string

Allowed values: user

new

One of:

null
object

null

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

required

string format: uuid

last_name

required

string

old

One of:

null
object

null

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

required

string format: uuid

last_name

required

string

A change to the item’s threat objectives, as the set added and the set removed.

object

added

required

Array<object>

A threat objective paired with how relevant it is to a risk.

Two relations are considered the same when the objective and its relevance match; created_date records when the relation was last changed and is not part of its identity.

object

created_date

The time that this relation was mutated

string | null format: date-time

relevance

One of:

null
string

null

threat_objective

required

The threat objective type

string

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

field

required

string

kind

required

string

Allowed values: threat_objectives

removed

required

Array<object>

A threat objective paired with how relevant it is to a risk.

Two relations are considered the same when the objective and its relevance match; created_date records when the relation was last changed and is not part of its identity.

object

created_date

The time that this relation was mutated

string | null format: date-time

relevance

One of:

null
string

null

threat_objective

required

The threat objective type

string

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

is_creation

required

True only for the actual first (creation) history row. False for all subsequent rows, including dummy rows inserted by touch_history() when a comment is added.

boolean

timestamp

required

string format: date-time

user

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

required

string format: uuid

last_name

required

string

Example

{
  "results": [
    {
      "changes": [
        {
          "kind": "text"
        }
      ]
    }
  ]
}

404

Risk not found