canonical: https://jentic.com/apis/quickschools.com/quickschools

# QuickSchools API

QuickSchools.com is an Online School Management System. The REST API allows querying and modifying school data including students, teachers, parents, classes, sections, assignments, grades, and attendance. The API exposes 45 endpoints secured with apiKey authentication.

## For AI agents

Programmatically get school group, list schools. Covers 45 operations with apiKey authentication.

## Scope

Does not handle payments, communications, or crm - use for education only.

## Capabilities

- Get school group
- List schools
- Access QuickSchools API education resources via REST API

## Use cases

### Education Operations

Use the QuickSchools API to perform education operations programmatically. The API provides 45 endpoints covering core functionality including get school group, list schools, get current school.

Example prompt: Call GET /schoolgroup to get school group

### Automated SchoolGroups Management

Automate schoolgroups operations by combining multiple QuickSchools API endpoints. Agents can list schools and then get current school in a single workflow.

Example prompt: Call GET /schools to list schools, then verify the result

### AI Agent Integration via Jentic

AI agents discover and call QuickSchools API endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Example prompt: Search Jentic for 'get school group', load the operation schema, and execute with Jentic-managed credentials

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | `/schoolgroup` | Get school group |
| GET | `/schools` | List schools |
| GET | `/school` | Get current school |
| GET | `/semesters` | List semesters |
| GET | `/semesters/{semesterId}` | Get semester |
| GET | `/classes` | List classes |
| GET | `/classes/{classId}` | Get class |
| GET | `/homerooms` | List homerooms |

## Key resources

- **SchoolGroups** — School group management
- **Schools** — School information
- **Semesters** — Semester management
- **Classes** — Class/grade level management
- **Homerooms** — Homeroom management

## Why Jentic

- **Setup:** Wiring QuickSchools by hand means passing its apiKey as a query parameter, targeting the api.quickschools.com host, and handling paging and retries across its school, semester, and class reads yourself. Through Jentic you install once, import QuickSchools from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** QuickSchools puts resource ids in the URL path (`/semesters/{semesterId}`, `/classes/{classId}`), so a rule can pin your agent to one class or semester: it reads that resource and nothing else. You choose the operations it may call, so it only reaches the reads you list, such as fetching schools or homerooms.
- **Credential handling:** Your QuickSchools API key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'list classes for a semester' or 'get a school by id', and Jentic returns the matching QuickSchools operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Stripe** — Complementary education API
- **Twilio** — Complementary education API
- **Sendgrid** — Complementary education API

## FAQ

### What authentication does the QuickSchools API use?

The QuickSchools API uses an API key passed in the `apiKey` query. Through Jentic, these credentials are stored encrypted in your Jentic One instance and injected at execution time, so raw secrets never enter the agent context.

### Can I get school group with the QuickSchools API?

Yes. Use the GET /schoolgroup endpoint. The API returns structured JSON responses that agents can parse and act on directly.

### What are the rate limits for the QuickSchools API?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

### How do I get school group through Jentic?

Install the Jentic SDK with pip install jentic, authenticate through Jentic One, the self-hosted execution layer, then search for 'get school group'. Jentic returns the matching QuickSchools API operation with its input schema. Load the schema and execute the call - credentials are injected automatically.

### How many endpoints does the QuickSchools API have?

The QuickSchools API exposes 45 endpoints covering schoolgroups, schools, semesters operations.

### Can I limit what my agent is allowed to do with the QuickSchools API?

Yes. Because you run Jentic One yourself, your own rules decide which QuickSchools operations and credentials the agent may use. You pick the exact operations it can call, so it reaches only the reads you list, such as fetching schools, semesters, or homerooms, and nothing else. Since QuickSchools carries resource ids in the path, like `/semesters/{semesterId}` and `/classes/{classId}`, a rule can pin the agent to a single class or semester so it reads that resource alone.
