Reports

Get a list of reports, optionally filtered + with stats

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.

get/reports

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/reports
  • Auth: HTTP bearer

Query parameters

reportType0 | 1 | 2 | 3
yearinteger nullable
currentYearOnlyboolean required
sportsOnlyboolean required
includeStatsboolean required
pageinteger required
pageSizeinteger required

Response

Success - Retrieved reports

Changes

No recorded changes to this operation across all 45 revisions of this API.