Skip to main content
GET
List exams
The list only includes exams created with the same API user as your access token.

Rules

  • Results are newest first, and paginated. Use page and page_size.
  • A page past the last page returns 404 with {"detail": "Invalid page."}.
  • examName matches part of a name, ignoring case. subject and examType match the whole name, ignoring case. examSet matches exactly.
  • An invalid filter value is ignored rather than rejected, so you get unfiltered results back.
pageSize in the response always reports 10, even when you send a different page_size. Count the items in data to see how many you actually got.
The grade filter only accepts 1 to 12. Any other value, including 13 for CA Foundation, is ignored.

Authorizations

Authorization
string
header
required

Access token from Get an access token. A missing, invalid, or expired token returns 403.

Query Parameters

page
integer
default:1

Page number, starting at 1.

Required range: x >= 1
page_size
integer
default:10

Exams per page, up to 1000. The pageSize field in the response always reports 10, whatever you send.

Required range: 1 <= x <= 1000
examName
string

Keep exams whose name contains this text, ignoring case.

Example:

"Pre Board"

grade
integer

Keep exams for this grade. Only 1 to 12 work here: any other value, including 13, is ignored and you get every grade back.

Required range: 1 <= x <= 12
subject
string

Keep exams with this subject. Matches the whole name, ignoring case.

Example:

"Science"

examType
string

Keep exams of this type. Matches the whole name, ignoring case.

Example:

"Pre Boards"

examSet
string

Keep exams with exactly this examSet.

Example:

"A"

Response

One page of exams.

count
integer

Total number of exams that match the filters.

pageSize
integer

Always 10, even when you send a different page_size. Count the items in data to see how many you got.

showing
string

Human readable position, such as Page 1 of 4.

next
string | null

URL of the next page, or null on the last page.

previous
string | null

URL of the previous page, or null on the first page.

data
object[]