Sign in

v3

latestOpenAPI 3.1.02026-07-311725107.3 KB
Issues

List issues

Retrieves a list of Issues associated with a Project. Supports JSON, newline-delimited JSON (application/x-ndjson), and CSV (text/csv) response formats via the Accept header.

get/gh/{ownerKeyOrId}/projects/{projectKeyOrId}/issues

Path parameters

ownerKeyOrIdstring required

Repository owner name (login) or workspace ID

Example:acme-corp

Repository owner name (login) or workspace ID

projectKeyOrIdstring required

Repository name or project ID

Example:my-repo

Repository name or project ID

Query parameters

page[limit]integer

Maximum number of items to return (1-100)

Example:20

Maximum number of items to return (1-100)

page[offset]integer nullable

Number of items to skip

Number of items to skip

string[]
OR
'bug' | 'vulnerability' | 'structure' | 'duplication' | 'security_hotspot' | 'performance' | 'documentation' | 'type_check' | 'style' | 'anti_pattern' | 'accessibility' | 'dead_code' | 'lint' | 'secret' | 'dependency_alert'

Filter by issue category

string[]
OR
'high' | 'medium' | 'low' | 'note' | 'fmt'

Filter by issue level

string[]
OR
'open' | 'ignored'

Filter by issue status (defaults to open)

string[]
OR
string

Filter by tool name

Response

List issues for the project

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "fingerprint": "abc123def456",
      "tool": "eslint",
      "ruleKey": "no-unused-vars",
      "message": "'foo' is defined but never used.",
      "category": "lint",
      "level": "medium",
      "status": "open",
      "documentationUrl": "https://eslint.org/docs/rules/no-unused-vars",
      "location": {
        "path": "src/index.ts",
        "startLine": 42,
        "endLine": 42
      }
    }
  ],
  "meta": {
    "hasMore": true
  }
}