SEsecurityscorecard
action plans

Get plans list

Changed on

Get plans list for the current user

get/plans

Request

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

Query parameters

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

Filter by action plan type

scorecardstring

Filter by scorecard

status'active' | 'completed'

Filter by status

Response

Action plans related to the current users

OR

Example response

{
  "entries": [
    {
      "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
    }
  ],
  "size": 100,
  "page": 1
}

Changes

  • b465b4846039Revision changes
    • breaking

      the query request parameter status was restricted to a list of enum values

    • breaking

      the query request parameter type was restricted to a list of enum values

    • breaking

      the response's body type changed from object to no type for status

    • 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 page

    • warning

      deleted the query request parameter pageSize

    • warning

      deleted the query request parameter search

    • warning

      deleted the query request parameter sort

    • info

      added the new enum value active to the query request parameter status

    • info

      added the new enum value completed to the query request parameter status

    • info

      added the new enum value factor_score_improvement to the query request parameter type

    • info

      added the new enum value issue_resolution to the query request parameter type

    • info

      added the new enum value overall_score_improvement to the query request parameter type

    • info

      added the new enum value remediation to the query request parameter type

    • info

      added to the response body anyOf list for the response status

    • 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