> ## Documentation Index
> Fetch the complete documentation index at: https://dev.schoolcues.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Resources

> The five resources the API serves and the fields each record has.

Every record has an `id`, `createdAt` and `updatedAt`. Times are ISO 8601 in UTC.

> [!NOTE]
>
> Birth dates, addresses, health information, attendance and grades are never
> served. Nothing can be changed through the API.

## Students

`/api/school/v1/students`, needs `students:read`.

| Field | Description |
| - | - |
| `studentNumber` | The school's student number |
| `givenName`, `middleName`, `familyName`, `preferredName` | Names |
| `gradeLevel` | Grade level |
| `active` | Whether the student is currently enrolled |
| `alumni` | Whether the student is an alumnus |
| `email` | The student's school email address |

## Contacts

`/api/school/v1/contacts`, needs `contacts:read`. The people related to students.

| Field | Description |
| - | - |
| `givenName`, `middleName`, `familyName`, `preferredName` | Names |
| `email`, `phone` | First email address and phone number |
| `students` | Each related student: `studentId`, `relationship` and `parent` (true or false) |

## Staff

`/api/school/v1/staff`, needs `staff:read`.

| Field | Description |
| - | - |
| `employeeNumber` | The school's employee number |
| `givenName`, `middleName`, `familyName`, `preferredName` | Names |
| `jobTitle` | Job title |
| `teacher` | Whether they teach |
| `active` | Whether they currently work at the school |
| `email` | Email address |

## Classes

`/api/school/v1/classes`, needs `classes:read`.

| Field | Description |
| - | - |
| `name` | Class name |
| `kind` | Kind of class |
| `academicYearId` | The academic year it belongs to |
| `active` | Whether it's active |
| `endsOn` | End date, if it has one |
| `teacherIds` | Staff IDs of its teachers |
| `studentIds` | IDs of its current students |

## Payments

`/api/school/v1/payments`, needs `payments:read`. Receipts for money the school received.

| Field | Description |
| - | - |
| `accountId`, `accountName` | The family account |
| `payerName` | Who paid |
| `amountCents`, `currency` | Amount in the currency's smallest unit |
| `method` | How it was paid |
| `purpose` | What it was for |
| `receivedAt` | When it was received |


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.