---
title: "Get a list of reports, optionally filtered + with stats"
method: GET
path: "/reports"
tags: ["Reports"]
---

# Get a list of reports, optionally filtered + with stats

`GET /reports`

**Requires permission:** *StaffMember*

Returns report details, optionally filtered by year group / current academic year / sport, optionally by report type (All/Ready/Open/Published), and optionally with completion stats.

## Query parameters

- `reportType` 0 | 1 | 2 | 3
- `year` integer, nullable
- `currentYearOnly` boolean, required
- `sportsOnly` boolean, required
- `includeStats` boolean, required
- `page` integer, required
- `pageSize` integer, required

## Response `200`

Success - Retrieved reports

- GetListOfReportsResponse
  - `reports` ReportDetail[], nullable
    - `name` string, required
    - `academicYear` integer
    - `yearGroup` string, required
    - `publishToParents` string, date-time, required
    - `publishToStudents` string, date-time, required
    - `sportAllocation` boolean
    - `draft` boolean
    - `hidden` boolean
    - `total` integer
    - `complete` integer
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

- `400` — An Error Occurred - Could not get reports
- `401` — Unauthorized
- `403` — Forbidden

---

[API](https://skmtc.net/tonbridge/apis/tonbridge-app-api.md) · [All operations](https://skmtc.net/tonbridge/apis/tonbridge-app-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/tonbridge/tonbridge-app-api/versions/28344aa564b4/schema)