Systemqueries

Run System Query

Requires permissions: AcademicStaff or AcademicSupport or StudentFacing

Run a system query by its key and return its columns and rows. Each query has its own bespoke, efficient EF. Refine toggles are passed as query parameters (e.g. ?overseas=true). Forbidden if the caller lacks its visibility roles.

get/SystemQueries/{key}

Request

  • Base URL: https://api.tonbridge.school
  • URL: https://api.tonbridge.school/SystemQueries/{key}
  • Auth: HTTP bearer

Path parameters

keystring required

Query parameters

pageinteger required
pageSizeinteger required
includesstring[] nullable
sortstring nullable
filterstring nullable

Response

Success

rowsobject[] nullable

Changes

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