---
title: "Get scan"
method: GET
path: "/scans/{id}"
tags: ["Scans"]
---

# Get scan

`GET /scans/{id}`

## Request

- Base URL: `https://app.codethreat.com/api/v1`
- URL: `https://app.codethreat.com/api/v1/scans/{id}`
- Auth: API key in header `X-API-Key`

Get details of a specific scan

## Path parameters

- `id` string, required

## Response `200`

Successful response

- ScanResponse
  - `success` boolean
  - `data` object
    - `id` string
    - `repositoryId` string
    - `status` 'PENDING' | 'SCANNING' | 'COMPLETED' | 'FAILED'
    - `scanTypes` string[]
    - `branch` string
    - `commit` string
    - `startedAt` string, date-time
    - `completedAt` string, date-time
    - `duration` integer
    - `violationCount` object
      - `critical` integer
      - `high` integer
      - `medium` integer
      - `low` integer
      - `info` integer
  - `pagination` Pagination
    - `page` integer
    - `limit` integer
    - `total` integer
    - `totalPages` integer
    - `hasNext` boolean
    - `hasPrev` boolean
  - `meta` ResponseMeta
    - `timestamp` string, date-time
    - `version` string
    - `requestId` string
    - `organizationId` string

## Other responses

- `404`: Resource not found

---

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