Skip to navigation
API ReferenceIssues

List issues

Unpaginated. For close reasons and the full record, use Get an issue. To be told about new findings instead of polling, register a webhook endpoint.

Requires the issues:read API key scope.

Authentication

AuthorizationBearer

A workspace API key, sent as Authorization: Bearer.

OR
x-api-keystring

A workspace API key, sent as x-api-key.

Query parameters

scanIdstringOptionalformat: "uuid"
Only issues from this pentest.
statusenumOptional
Allowed values:
severityenumOptional
Allowed values:
branchstringOptional

Response

Matching issues.
idstringformat: "uuid"
issueLabelstring or null

Human-facing reference shown in the Console.

titlestring
severityenum
Allowed values:
statusenum
Allowed values:
locationstring
urlstring
Console link to the issue.
closedAtdatetime or null
closedDispositionenum or null

Structured close verdict. other appears only on findings closed before it was retired and cannot be written.

duplicateOfstring or nullformat: "uuid"

Errors

401
Unauthorized Error
403
Forbidden Error