action plans

Get list of managed action plans for managed customers vendors

Changed on Nov 3, 2026

Get plan by id

get/plans/{id}

Request

Base URL
https://api.securityscorecard.io
URL
https://api.securityscorecard.io/plans/{id}
Auth
API key in header Authorization

Path parameters

idstring uuid required

action plan id

Response

Action plan

idstring

action plan identifier

remediation_versionstring

rolesstring[]

namestring

action plan name

descriptionstring

description

guestsstring[]

list of emails of guest users

editorsstring[]

list of emails of editors

created_bystring

user who created the object

created_atstring date-time

created date

updated_bystring

user who updated the object

updated_atstring date-time

created date

type'overall_score_improvement' | 'remediation' | 'issue_resolution' | 'factor_score_improvement'

action plan type

status'active' | 'completed'

action plan status

organization_domainstring

primary domain of the company

is_custom_scorecardboolean

true if this action plan is based on a custom scorecard, false otherwise

company_namestring

company_scoreinteger

security score from 0 to 100

is_managedboolean

is_publishedboolean

managed_scorecardstring

total_issuesnumber

number of issues associated to the action plan

closed_issuesnumber

number of closed issues associated to the action plan

progressnumber

percentage of progress

Example response

{
  "id": "aea7dae2-370f-4279-a458-4c7cb9661778",
  "name": "Example action plan",
  "description": "Example description",
  "due_date": "2020-01-01T00:00:00.000Z",
  "scorecard": "example.com",
  "created_by": "user@example.com",
  "created_at": "2020-01-01T00:00:00.000Z",
  "updated_by": "user@example.com",
  "updated_at": "2020-01-01T00:00:00.000Z",
  "type": "overall_score_improvement",
  "status": "active",
  "organization_domain": "example.com",
  "archived_at": "2020-01-01T00:00:00.000Z",
  "synchronized_at": "2020-01-01T00:00:00.000Z",
  "company_name": "Example Ltd.",
  "company_score": 95,
  "factor_scores": [
    {
      "factor": "network_security",
      "score": 95
    }
  ],
  "target": {
    "factor_score_targets": [
      {
        "factor": "network_security",
        "score": 95
      }
    ],
    "overall_score": 90
  },
  "criteria": {
    "factors": [
      "network_security"
    ],
    "issues": [
      "cookie_secure_flag"
    ]
  },
  "total_issues": 36,
  "items": [
    {
      "name": "cookie_secure_flag",
      "impact": 0.034,
      "status": "open"
    }
  ]
}

Changes

Nov 3, 2026b465b4846039 Revision changes
- breaking
  added the pattern ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$ to the path request parameter id
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- breaking
  removed the required property from the response with the status
- warning
  deleted the query request parameter filter
- warning
  deleted the query request parameter pageIndex
- warning
  deleted the query request parameter pageSize
- warning
  deleted the query request parameter search
- warning
  deleted the query request parameter sort
- info
  media type application/json; charset=utf-8 was changed to application/json for the response status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the non-success response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status

Operation history