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

# API Reference

> Every endpoint, record and webhook event a school's own systems can use, generated from the SchoolCues code.

The API reads a school's students, contacts, staff, classes and payments. It is read-only, and returns JSON.

## Base URL

```
https://portal.schoolcues.com/api/school/v1
```

A school administrator copies it, with the key, from **Copy Your API Key** on the [API's page](https://portal.schoolcues.com/settings/integrations/api).

## Authentication

Send one of the school's API keys as a bearer token with every request:

```bash theme={null}
curl https://portal.schoolcues.com/api/school/v1/students \
  -H "Authorization: Bearer sk_..."
```

Each key reads only the resources the school chose for it, such as `students:read`. See [API keys](https://dev.schoolcues.com/api/keys.md).

OneRoster uses an access token instead, from [Create an access token](https://dev.schoolcues.com/reference/oneroster/access-tokens/create-an-access-token.md).

## Lists and paging

Lists return `data`, `total`, `limit` and `offset`, oldest change first. Pass the latest `updatedAt` you have read as `updatedSince` to read only what changed. See [Paging and changes](https://dev.schoolcues.com/api/requests.md).

## Errors

A refused request answers with its HTTP status and a body whose `statusMessage` says what went wrong.

| Status | Meaning |
| - | - |
| `400` | A query parameter isn't valid. The message says which. |
| `401` | The key is missing, revoked or expired. |
| `403` | The key can't read this resource. |
| `404` | The resource or record doesn't exist. |
| `503` | SchoolCues couldn't check the key just now. Retry soon. |

## Webhooks

Webhooks post an event when a record changes. Each event's page shows what it sends. See [Webhooks](https://dev.schoolcues.com/webhooks/overview.md) to add one and [Verify signatures](https://dev.schoolcues.com/webhooks/verify-signatures.md) to check them.


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