List exams
List the exams created with your access token, newest first, with filters for name, grade, subject, type, and set.
Rules
- Results are newest first, and paginated. Use
pageandpage_size. - A
pagepast the last page returns404with{"detail": "Invalid page."}. examNamematches part of a name, ignoring case.subjectandexamTypematch the whole name, ignoring case.examSetmatches exactly.- An invalid filter value is ignored rather than rejected, so you get unfiltered results back.
grade filter only accepts 1 to 12. Any other value, including 13 for CA Foundation, is ignored.Authorizations
Access token from Get an access token. A missing, invalid, or expired token returns 403.
Query Parameters
Page number, starting at 1.
x >= 1Exams per page, up to 1000. The pageSize field in the response always reports 10, whatever you send.
1 <= x <= 1000Keep exams whose name contains this text, ignoring case.
"Pre Board"
Keep exams for this grade. Only 1 to 12 work here: any other value, including 13, is ignored and you get every grade back.
1 <= x <= 12Keep exams with this subject. Matches the whole name, ignoring case.
"Science"
Keep exams of this type. Matches the whole name, ignoring case.
"Pre Boards"
Keep exams with exactly this examSet.
"A"
Response
One page of exams.
Total number of exams that match the filters.
Always 10, even when you send a different page_size. Count the items in data to see how many you got.
Human readable position, such as Page 1 of 4.
URL of the next page, or null on the last page.
URL of the previous page, or null on the first page.