GET: Plan Selection

Erin Conry

https://api.bitsighttech.com/ratings/v1/companies/company_guid/risk-remediation-plan/selections

Get the requesting user's selected plan setting and latest completed run for each supported risk vector. Use this to display the current plan state across all vectors on a dashboard or overview page.

Example Request

curl https://api.bitsighttech.com/ratings/v1/companies/a940bb61-33c4-42c9-9231-c8194c305db3/risk-remediation-plan/selections \
  -u api_token:

Example Response

{
  "web_appsec": {
    "settings": {
      "guid": "22c85f64-5717-4562-b3fc-2c963f66afa9",
      "name": "Exclude critical CVEs",
      "is_shared": false,
      "user_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    },
    "latest_run": {
      "rrp_guid": "3fa85f64-5717-4562-b3fc-2c963f66afa7",
      "created_at": "2026-04-15T20:35:13.775Z"
    }
  },
  "ssl_certificates": null,
  "dmarc": {
    "settings": null,
    "latest_run": {
      "rrp_guid": "5ba85f64-5717-4562-b3fc-2c963f66afc1",
      "created_at": "2026-04-14T05:00:00.000Z"
    }
  }
}

Response Attributes

Field	Description
{risk_vector} Object or Null	Selection state for this risk vector. `null` means no base plan has been run yet for this vector.
{risk_vector}.settings Object or Null	The custom setting selected by this user for the vector. `null` when the base plan is selected. Includes `guid`, `name`, `is_shared`, and `user_guid`.
{risk_vector}.latest_run.rrp_guid String [`uuid`]	GUID of the most recent completed plan run for this vector and setting combination.
{risk_vector}.latest_run.created_at String [datetime]	ISO 8601 timestamp of when the most recent completed plan run finished.

Status Codes

200 – Okay: Everything worked as expected.
401 – Unauthorized: No valid API token was provided.
403 – Permission Denied: You do not have permission to access this resource.
422 – Unprocessable Entity: A path parameter value is invalid.