---
title: "List coverage files"
method: GET
path: "/api/v1/user/projects/{projectId}/coverage/files"
tags: ["Coverage"]
---

# List coverage files

`GET /api/v1/user/projects/{projectId}/coverage/files`

## Request

- Base URL: `https://app.gaffer.sh`
- URL: `https://app.gaffer.sh/api/v1/user/projects/{projectId}/coverage/files`
- Auth: one of:
  - API key in header `X-API-Key`
  - API key in header `X-API-Key`
  - HTTP bearer

Returns per-file coverage data for the project's latest coverage report.
Supports filtering by path, coverage thresholds, sorting, and pagination.

## Path parameters

- `projectId` string, required

## Query parameters

- `filePath` string
- `minCoverage` number
- `maxCoverage` number
- `limit` integer
- `offset` integer
- `sortBy` 'path' | 'coverage'
- `sortOrder` 'asc' | 'desc'

## Response `200`

Per-file coverage data

- CoverageFilesResponse: Per-file coverage data. When `hasCoverage` is false, files array is empty.
  - `hasCoverage` boolean, required
  - `files` CoverageFile[], required
    - `path` string, required
    - `lines` CoverageMetric, required
      - `covered` integer, required
      - `total` integer, required
      - `percentage` number, required
    - `branches` CoverageMetric, required
      - `covered` integer, required
      - `total` integer, required
      - `percentage` number, required
    - `functions` CoverageMetric, required
      - `covered` integer, required
      - `total` integer, required
      - `percentage` number, required
  - `pagination` Pagination, required
    - `limit` integer, required
    - `offset` integer, required
    - `total` integer, required
    - `hasMore` boolean, required
  - `overallCoverage` number, nullable: Overall project coverage percentage
  - `message` string, nullable

## Other responses

- `400`: Invalid request parameters
- `401`: Missing or invalid API key
- `404`: Resource not found

---

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