Get a code quality finding | Sample

3 parameters

ownerstringrequired

The account owner of the repository. The name is not case sensitive.

repostringrequired

The name of the repository without the `.git` extension. The name is not case sensitive.

finding_numberintegerrequired

The number that identifies a finding.

4 status codes

200Response

numberintegerrequired

The finding number.

statestringrequired

State of the code quality finding.

Allowed:opendismissed

urlstringrequired

The REST API URL of the code quality finding resource.

ruleobjectrequired

Code quality rule

locationobjectrequired

Code quality file location

messageobjectrequired

Code quality finding message

created_atstringoptional

The time the code quality finding was created.

403Response if the user is not authorized to access Code quality for this repository.

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

404Resource not found

messagestringoptional

documentation_urlstringoptional

urlstringoptional

statusstringoptional

503Service unavailable

codestringoptional

messagestringoptional

documentation_urlstringoptional

Error handling

A 403 is returned: Response if the user is not authorized to access Code quality for this repository. A 404 is returned: Resource not found. A 503 is returned: Service unavailable.

import { Client } from "acme-sdk";

const client = new Client({
  baseUrl: "https://api.acme.com",
  auth: { bearer: process.env.API_TOKEN },
  retry: {
    maxAttempts: 3,
    retryOn: [
      408,
      425,
      429,
      500,
      502,
      503,
      504,
    ],
    backoffMs: 500,
    maxBackoffMs: 8000,
  },
  timeoutMs: 30000,
});

const result = await client.findings.get({
  owner: "octocat",
  repo: "hello-world",
  findingNumber: "example",
});

{
  "number": 42,
  "state": "open",
  "url": "https://api.github.com/repos/octocat/hello-world/code-quality/findings/42",
  "rule": {
    "id": "java/useless-null-check",
    "title": "Useless null check",
    "description": "Checking whether an expression is null when that expression cannot possibly be null is useless.",
    "help": "# Useless null check\nSometimes you can guarantee that a particular variable will never be null. For example when that variable has just been assigned a newly created object or is the exception caught by a `catch` clause. A null check on such a variable is ...",
    "severity": "warning",
    "category": "maintainability"
  },
  "location": {
    "path": "java/UselessNullCheck.java",
    "start_line": 9,
    "start_column": 4,
    "end_line": 9,
    "end_column": 18
  },
  "message": {
    "text": "This check is useless. o cannot be null at this check, since it is guarded by instanceof.",
    "markdown": "This check is useless. [o](java/UselessNullCheck.java#L9C4-L9C18) cannot be null at this check, since it is guarded by [...instanceof...](java/UselessNullCheck.java#L7C13-L7C25)."
  },
  "created_at": "2026-01-23T12:34:56Z"
}

Request

Response

Errors