Skip to content

Get many findings (full detail)

View .md
GET
/projects/{projectId}/findings/details
curl --request GET \
--url 'https://zkao.io/api/v1/projects/example/findings/details?page=1&limit=25' \
--header 'Authorization: Bearer <token>'

Requires scope: read. The full detail of a scan’s findings, of a set of findings, or both, in one call. Returns the findings shown in the app: confirmed or inconclusive, on scans the project can see.

projectId
required
string
page
integer
default: 1 >= 1
limit
integer
default: 25 >= 1 <= 50
scanId
string

Only findings belonging to this scan.

ids
string

Comma-separated finding ids or ZK- labels, at most 50. Ids that match nothing are listed in missing.

OK

Media typeapplication/json
object
items
required
Array
object
id
required
string
displayId
required
integer
title
required
string
location
required
string
severity
required

Effective severity (user override if set, else AI severity).

string
Allowed values: CRITICAL HIGH MEDIUM LOW INFO
category
required
string
triageStatus
required
string
Allowed values: PENDING NEW DUPLICATE RECURRING CONFIRMED FALSE_POSITIVE INCONCLUSIVE
confirmationEvidence

What backs a CONFIRMED verdict. POC means a proof of concept ran and demonstrated the issue. ANALYSIS means it was confirmed by code analysis alone. Null for other statuses or when not recorded.

string | null
Allowed values: POC ANALYSIS
resolutionStatus
required
string
Allowed values: NOT_STARTED IN_PROGRESS RESOLVED WONT_FIX MITIGATED FALSE_POSITIVE DUPLICATE
notesCount
required
integer
source
required

Where the finding was found.

object
kind
required

The kind of scan that found it. One of continuous-security, pr-review, flash, max, flash-diff, max-diff, supply-chain, flash-retriage, max-retriage, flash-regression-check, max-regression-check, manual-audit, report-investigation or other. New kinds may be added, so treat an unknown kind like other.

string
branch
required

The branch the scan ran on. Null when the scan recorded none, such as a scan of a pinned commit.

string | null
dismissalReason
required

Why triage dismissed the finding as a false positive. Null when triage did not dismiss it or gave no reason.

string | null
triageOverriddenFrom
required
One of:
string
Allowed values: PENDING NEW DUPLICATE RECURRING CONFIRMED FALSE_POSITIVE INCONCLUSIVE
triageOverriddenAt
required
string | null format: date-time
triageOverriddenByName
required

Name, or email when there is no name, of the member who overrode triage.

string | null
description
required
string
impact
required
string
recommendation
required
string
assumptions
required
Array<string>
pocReport
string | null
recommendedFix
string | null
scanId
required
string
commitHash
string | null
repo
object
owner
string
name
string
url
string
createdAt
required
string format: date-time
notes
required
Array<object>
object
id
required
string
body
required

Markdown. A page of the app the assistant names is an absolute link.

string
createdAt
required
string format: date-time
author
object
id
string
name
string | null
email
string
page
required
integer
limit
required
integer
total
required
integer
missing
required

The requested ids that matched no finding.

Array<string>
Example
{
"items": [
{
"severity": "CRITICAL",
"triageStatus": "PENDING",
"confirmationEvidence": "POC",
"resolutionStatus": "NOT_STARTED",
"triageOverriddenFrom": "PENDING"
}
]
}

Invalid request

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

Missing, malformed, expired, or revoked token

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

The token lacks the required scope

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}

Resource not in this token’s project or repo allowlist

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal
message
required
string
minimumCredits

Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

integer
Example
{
"error": {
"code": "unauthorized"
}
}