Skip to main content
GET
/
gh
/
{ownerKeyOrId}
/
projects
/
{projectKeyOrId}
/
issues
List issues
curl --request GET \
  --url https://api.qlty.sh/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/issues \
  --header 'Authorization: Bearer <token>'
{
  "meta": {
    "hasMore": false
  },
  "data": [
    {
      "id": "49b5e789-cff8-47d2-bd1c-72a469980e15",
      "fingerprint": "3a1b2c3d4e5f6g7h8i9j",
      "tool": "eslint",
      "ruleKey": "no-unused-vars",
      "message": "Variable is defined but never used",
      "category": "lint",
      "level": "medium",
      "status": "open",
      "documentationUrl": "https://eslint.org/docs/rules/no-unused-vars",
      "location": {
        "path": "src/components/Button.tsx",
        "startLine": 15,
        "endLine": 15
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Generate an API token at https://qlty.sh/user/settings/tokens

Path Parameters

​
ownerKeyOrId
string
required

The key or ID of the Workspace that owns the Project

​
projectKeyOrId
string
required

The key or ID of the Project to retrieve issues for

Query Parameters

​
category
enum<string>[]

Filter issues by category

Available options:
bug,
vulnerability,
structure,
duplication,
security_hotspot,
performance,
documentation,
type_check,
style,
anti_pattern,
accessibility,
dead_code,
lint,
secret,
dependency_alert
​
level
enum<string>[]

Filter issues by severity level

Available options:
note,
fmt,
low,
medium,
high
​
status
enum<string>[]

Filter issues by status (defaults to open only)

Available options:
open,
ignored
​
tool
string[]

Filter issues by the tool that detected them (e.g., eslint, typescript)

​
page[limit]
integer

Maximum number of items to return

​
page[offset]
integer

Number of items to skip

Response

Successful response

​
data
object[]
required

List of Issue items returned in the response

​
meta
object
required