academyFIVE API Beta icon

academyFIVE API Beta

Interact with academyFIVE API

Actions482

Grades [Beta] → Find grades

AI-generated

Summary

Fetches grades from the academyFIVE API using query filters for booking, curriculum entry, and subject IDs.

Inputs

  • additionalFields.page(number) — The page number for pagination, defaulting to 1.
  • additionalFields.page(size) — The number of items per page for pagination, defaulting to 50.
  • additionalFields.filter(bookingId) — Search for grades by booking ID.
  • additionalFields.filter(curriculumEntryId) — Search for grades by curriculum entry ID.
  • additionalFields.filter(subjectId) — Search for grades by subject ID.
  • additionalFields.include — Comma-separated included relationships.

Output shape

A list of items containing grade records.

Parameters are optional; if provided, they are sent as query parameters to the API endpoint.

Examples

Example 1: Fetch the first page of all grades.

Set 'additionalFields.page(number)' to 1 and leave other fields empty.

Example 2: Retrieve grades for a specific booking.

Set 'additionalFields.filter(bookingId)' to the desired booking ID.

Example 3: Paginate through results to get more than 50 items.

Set 'additionalFields.page(size)' to a higher number (e.g., 100).

Links

Discussion