---
title: "Get issue"
method: POST
path: "/api/v1/issues/get"
tags: ["Issues"]
---

# Get issue

`POST /api/v1/issues/get`

## Request

- Base URL: `https://zeropath.com`
- URL: `https://zeropath.com/api/v1/issues/get`
- Auth: API key in header `X-ZeroPath-API-Token-Id` and API key in header `X-ZeroPath-API-Token-Secret`

## Request body

- GetIssueInput
  - `issueId` string, required
  - `organizationId` string

## Response `200`

Successful response

- Issue
  - `id` string, required
  - `repositoryId` string, required
  - `repositoryName` string
  - `status` 'open' | 'patched' | 'falsePositive' | 'notExploitable' | 'archived' | 'silenced', required
  - `issueStatus` 'PENDING_REVIEW' | 'REVIEWING' | 'PATCHING' | 'NON_EXPLOITABLE' | 'FALSE_POSITIVE' | 'ACCEPTED_RISK' | 'RESOLVED' | 'BACKLOG' | 'INFORMATIONAL'
  - `generatedTitle` string, required
  - `generatedDescription` string, required
  - `businessLogicScenario` string
  - `language` string, required
  - `vulnClass` string, required
  - `cwes` string[], required
  - `vulnCategory` 'SAST' | 'SCA' | 'IAC' | 'SECRETS' | 'SMART_CONTRACT', required
  - `severity` number, nullable, required: Raw severity (0-10); null when no severity was ever measured for the finding, e.g. a dependency advisory with no CVSS score.
  - `confidence` number
  - `score` integer, nullable: Composite ZeroPath score (0-100, severity x confidence); null when no severity was ever measured for the finding. Such a finding belongs to no score band.
  - `discoveryTool` string, required
  - `codeScanId` string, required
  - `affectedFile` string, required
  - `sastCodeSegment` string, required
  - `startLine` integer, required
  - `endLine` integer, required
  - `startColumn` integer
  - `endColumn` integer
  - `isPrBlocked` boolean, required
  - `validated` 'CONFIRMED' | 'DISCONFIRMED' | 'UNKNOWN', nullable
  - `validationSecurityAssessment` string, nullable
  - `unpatchable` boolean, nullable
  - `unpatchableReason` string, nullable
  - `unpatchableRemediationInstructions` string, nullable
  - `archivedAt` string, date-time, nullable
  - `noLongerDetectedAt` string, date-time, nullable
  - `noLongerDetectedReason` string, nullable
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required
  - `naturalLanguageRuleEvaluationId` string, nullable: ID of the natural language rule evaluation that found this issue (if applicable)
  - `naturalLanguageRuleViolationId` string, nullable: ID of the natural language rule violation that found this issue (if applicable)
  - `naturalLanguageRuleViolation` object, nullable: Natural language rule violation details if this issue was found by a custom rule
    - `id` string, required: Unique identifier for the rule violation
    - `ruleId` string, required: ID of the rule that was violated
    - `title` string, required: Title of the violation
    - `description` string, required: Detailed description of why this is a violation
    - `confidence` number, required: Confidence score for the violation (0-1)
    - `rule` object, nullable: The rule that was violated
      - `id` string, required: Unique identifier for the rule
      - `name` string, nullable, required: Name of the rule
  - `codeScan` object
    - `id` string
    - `scanTargetBranchCommitSha` string, nullable
  - `stateChangeAuthor` string
  - `closedBy` object, nullable
    - `id` string, nullable
    - `name` string, nullable
    - `email` string, nullable
  - `falsePositiveReason` string, nullable
  - `falsePositiveAt` string, date-time, nullable
  - `introducedBy` object, nullable
    - `contributorId` string, nullable
    - `userId` string, nullable
    - `name` string, nullable
    - `email` string, nullable
    - `platform` string, nullable
    - `username` string, nullable
    - `profileUrl` string, nullable
    - `profileImageUrl` string, nullable
    - `lineStart` integer, nullable
    - `lineEnd` integer, nullable
    - `timestamp` string, date-time, nullable
  - `scaVulnerabilityAlertingGroupId` string, nullable: ID of the SCA vulnerability alerting group that created this issue (if applicable)
  - `scaReachabilityAnalyses` object[], nullable: Reachability analyses associated with this SCA vulnerability
    - `id` string, required
    - `title` string, nullable
    - `description` string, nullable
    - `confidence` number, nullable
    - `severity` number, nullable
    - `isFalsePositive` boolean, nullable
    - `falsePositiveReasoning` string, nullable
    - `pocCode` string, nullable
    - `vulnerabilityLocation` object, nullable
      - `id` string
      - `filePath` string, nullable
      - `startLine` integer, nullable
      - `endLine` integer, nullable
      - `startColumn` integer, nullable
      - `endColumn` integer, nullable
      - `snippet` string, nullable
      - `language` string, nullable
    - `cvssScore` object, nullable
      - `id` string
      - `cvssVector` string, nullable
      - `severity` number, nullable
  - `patchAttemptErrorDuringScan` object
    - `id` string
    - `rawError` string
    - `displayError` string
    - `errorType` string
    - `createdAt` string, date-time
  - `prSubmissionErrorDuringScan` object
    - `id` string
    - `rawError` string
    - `displayError` string
    - `errorType` string
    - `createdAt` string, date-time
  - `patch` object, nullable
    - `id` string
    - `prLink` string, nullable
    - `prTitle` string, nullable
    - `prDescription` string, nullable
    - `gitDiff` string
    - `pullRequestStatus` string
    - `validated` string
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
  - `detectedSecret` object, nullable
    - `detectorName` string, nullable
    - `detectorDescription` string, nullable
    - `decoderName` string, nullable
    - `rotationGuide` string, nullable
    - `redactedSecret` string, nullable
    - `verified` boolean, nullable
  - `url` string, required: URL to view the issue in the ZeroPath UI

## Other responses

- `400`: Bad Request
- `401`: Unauthorized

---

[API](https://skmtc.dev/zeropath/apis/zeropath-api-2.md) - [All operations](https://skmtc.dev/zeropath/apis/zeropath-api-2/llms.txt) - [OpenAPI document](https://skmtc.dev/zeropath/apis/zeropath-api-2/revisions/ea6ae4b68cd3?raw)