---
title: "Run System Query"
method: GET
path: "/SystemQueries/{key}"
tags: ["Systemqueries"]
---

# Run System Query

`GET /SystemQueries/{key}`

**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.

## Path parameters

- `key` string, required

## Query parameters

- `page` integer, required
- `pageSize` integer, required
- `includes` string[], nullable
- `sort` string, nullable
- `filter` string, nullable

## Response `200`

Success

- GetSystemQueryResponse
  - `columns` SystemQueryColumn[], nullable
    - `key` string
    - `label` string
  - `rows` object[], nullable
  - `meta` Meta
    - `page` integer
    - `pageSize` integer
    - `total` integer

## Other responses

- `401` — Unauthorized
- `403` — Forbidden - Not visible to the caller
- `404` — Not Found - No such system query

---

[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)