Skip to main content
GET
/
v1
/
assessments
List assessments
curl --request GET \
  --url https://api.app.chainloop.dev/v1/assessments \
  --header 'Authorization: Bearer <token>'
{
  "pagination": {
    "total_count": 2,
    "page": 5,
    "total_pages": 7,
    "page_size": 5
  },
  "results": [
    {
      "justification_code": "ASSESSMENT_JUSTIFICATION_CODE_UNSPECIFIED",
      "note": "note",
      "remediation_branch_name": "remediation_branch_name",
      "created_at": "2000-01-23T04:56:07.000Z",
      "external_id": "external_id",
      "remediation_pr_url": "remediation_pr_url",
      "products": [
        {
          "purl_glob": "purl_glob"
        },
        {
          "purl_glob": "purl_glob"
        }
      ],
      "remediation_status": "remediation_status",
      "updated_at": "2000-01-23T04:56:07.000Z",
      "project_id": "project_id",
      "cvss_vector": "cvss_vector",
      "scope": "ASSESSMENT_SCOPE_UNSPECIFIED",
      "id": "id",
      "severity": "FINDING_SEVERITY_UNSPECIFIED",
      "effective_reviewed_at": "2000-01-23T04:56:07.000Z",
      "pending_revision": {
        "justification_code": null,
        "note": "note",
        "approval_status": "ASSESSMENT_APPROVAL_STATUS_UNSPECIFIED",
        "reviewed_at": "2000-01-23T04:56:07.000Z",
        "created_at": "2000-01-23T04:56:07.000Z",
        "assessment_id": "assessment_id",
        "project_version_id": "project_version_id",
        "reviewer": {
          "intercom_hash": "intercom_hash",
          "created_at": "2000-01-23T04:56:07.000Z",
          "last_name": "last_name",
          "id": "id",
          "first_name": "first_name",
          "email": "email",
          "instance_admin": true
        },
        "created_by": {
          "api_token": {
            "id": "id"
          },
          "type": "ASSESSMENT_CREATOR_TYPE_UNSPECIFIED",
          "user": {
            "intercom_hash": "intercom_hash",
            "created_at": "2000-01-23T04:56:07.000Z",
            "last_name": "last_name",
            "id": "id",
            "first_name": "first_name",
            "email": "email",
            "instance_admin": true
          },
          "ai_agent": {
            "name": "name"
          }
        },
        "revision": 1,
        "products": [
          {
            "purl_glob": "purl_glob"
          },
          {
            "purl_glob": "purl_glob"
          }
        ],
        "review_note": "review_note",
        "scope": null,
        "id": "id",
        "status": null
      },
      "remediation_pr_number": 0,
      "project_version_id": "project_version_id",
      "remediation_confidence": 6.027456183070403,
      "created_by": {
        "api_token": {
          "id": "id"
        },
        "type": "ASSESSMENT_CREATOR_TYPE_UNSPECIFIED",
        "user": {
          "intercom_hash": "intercom_hash",
          "created_at": "2000-01-23T04:56:07.000Z",
          "last_name": "last_name",
          "id": "id",
          "first_name": "first_name",
          "email": "email",
          "instance_admin": true
        },
        "ai_agent": {
          "name": "name"
        }
      },
      "remediation_status_reason": "remediation_status_reason",
      "remediation_updated_at": "2000-01-23T04:56:07.000Z",
      "organization_id": "organization_id",
      "effective_reviewer": {
        "intercom_hash": "intercom_hash",
        "created_at": "2000-01-23T04:56:07.000Z",
        "last_name": "last_name",
        "id": "id",
        "first_name": "first_name",
        "email": "email",
        "instance_admin": true
      },
      "status": "ASSESSMENT_STATUS_UNSPECIFIED"
    },
    {
      "justification_code": "ASSESSMENT_JUSTIFICATION_CODE_UNSPECIFIED",
      "note": "note",
      "remediation_branch_name": "remediation_branch_name",
      "created_at": "2000-01-23T04:56:07.000Z",
      "external_id": "external_id",
      "remediation_pr_url": "remediation_pr_url",
      "products": [
        {
          "purl_glob": "purl_glob"
        },
        {
          "purl_glob": "purl_glob"
        }
      ],
      "remediation_status": "remediation_status",
      "updated_at": "2000-01-23T04:56:07.000Z",
      "project_id": "project_id",
      "cvss_vector": "cvss_vector",
      "scope": "ASSESSMENT_SCOPE_UNSPECIFIED",
      "id": "id",
      "severity": "FINDING_SEVERITY_UNSPECIFIED",
      "effective_reviewed_at": "2000-01-23T04:56:07.000Z",
      "pending_revision": {
        "justification_code": null,
        "note": "note",
        "approval_status": "ASSESSMENT_APPROVAL_STATUS_UNSPECIFIED",
        "reviewed_at": "2000-01-23T04:56:07.000Z",
        "created_at": "2000-01-23T04:56:07.000Z",
        "assessment_id": "assessment_id",
        "project_version_id": "project_version_id",
        "reviewer": {
          "intercom_hash": "intercom_hash",
          "created_at": "2000-01-23T04:56:07.000Z",
          "last_name": "last_name",
          "id": "id",
          "first_name": "first_name",
          "email": "email",
          "instance_admin": true
        },
        "created_by": {
          "api_token": {
            "id": "id"
          },
          "type": "ASSESSMENT_CREATOR_TYPE_UNSPECIFIED",
          "user": {
            "intercom_hash": "intercom_hash",
            "created_at": "2000-01-23T04:56:07.000Z",
            "last_name": "last_name",
            "id": "id",
            "first_name": "first_name",
            "email": "email",
            "instance_admin": true
          },
          "ai_agent": {
            "name": "name"
          }
        },
        "revision": 1,
        "products": [
          {
            "purl_glob": "purl_glob"
          },
          {
            "purl_glob": "purl_glob"
          }
        ],
        "review_note": "review_note",
        "scope": null,
        "id": "id",
        "status": null
      },
      "remediation_pr_number": 0,
      "project_version_id": "project_version_id",
      "remediation_confidence": 6.027456183070403,
      "created_by": {
        "api_token": {
          "id": "id"
        },
        "type": "ASSESSMENT_CREATOR_TYPE_UNSPECIFIED",
        "user": {
          "intercom_hash": "intercom_hash",
          "created_at": "2000-01-23T04:56:07.000Z",
          "last_name": "last_name",
          "id": "id",
          "first_name": "first_name",
          "email": "email",
          "instance_admin": true
        },
        "ai_agent": {
          "name": "name"
        }
      },
      "remediation_status_reason": "remediation_status_reason",
      "remediation_updated_at": "2000-01-23T04:56:07.000Z",
      "organization_id": "organization_id",
      "effective_reviewer": {
        "intercom_hash": "intercom_hash",
        "created_at": "2000-01-23T04:56:07.000Z",
        "last_name": "last_name",
        "id": "id",
        "first_name": "first_name",
        "email": "email",
        "instance_admin": true
      },
      "status": "ASSESSMENT_STATUS_UNSPECIFIED"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.chainloop.dev/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

Bearer token for authentication

Query Parameters

​
scope
enum<string>
default:ASSESSMENT_SCOPE_UNSPECIFIED

Filter by scope

Available options:
ASSESSMENT_SCOPE_UNSPECIFIED,
ASSESSMENT_SCOPE_PROJECT,
ASSESSMENT_SCOPE_PROJECT_VERSION
​
status
enum<string>
default:ASSESSMENT_STATUS_UNSPECIFIED

Filter by status

Available options:
ASSESSMENT_STATUS_UNSPECIFIED,
ASSESSMENT_STATUS_NOT_AFFECTED,
ASSESSMENT_STATUS_AFFECTED,
ASSESSMENT_STATUS_UNDER_INVESTIGATION,
ASSESSMENT_STATUS_FIXED
​
external_id
string

Filter by external ID (e.g. CVE identifier)

​
project_name
string

Filter by project name

​
pagination.page
integer<int32>

The (zero-based) offset of the first item returned in the collection.

​
pagination.page_size
integer<int32>

The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

​
project_version_name
string

Filter by project version name

​
finding_id
string

Filter by finding ID to list assessments linked to a specific finding

Filter by finding ID

​
has_findings
boolean

Filter by whether the assessment has any linked findings

Filter by presence of linked findings. True = only with findings, false = only without

​
has_pending_revision
boolean

Filter by whether the assessment has a pending revision awaiting review

Filter by presence of a pending revision. True = only with a pending review, false = only without

​
relevant_to_project_version
boolean

When true, only return assessments relevant to the target project version (version-scoped, or project-scoped with findings linked on that version). Applied only when project_version_name is set; otherwise ignored.

Response

A successful response.

Response for List method

​
results
AssessmentItem · object[]
​
pagination
OffsetPaginationResponse is used to return the pagination information · object
Example:
{
  "total_count": 2,
  "page": 5,
  "total_pages": 7,
  "page_size": 5
}