Teachify Admin API Queries
Note: The Teachify Admin API is currently under development and not yet available for public use. This documentation is provided for preview purposes only.
Overview
The Teachify Admin API provides several query operations for retrieving data from your school. This page provides a high-level overview of available queries.
Core Concepts
Before diving into specific queries, familiarize yourself with these core concepts:
- Pagination - How to paginate through large result sets
- Filtering - How to filter query results
Resource-Specific Documentation
For detailed information about specific resources, see:
- Courses - Query course information
- Events - Query calendar events
- Students - Query student information
- Assignments - Query assignment information
Available Queries
The API provides the following main query operations:
Query | Description | Documentation |
---|---|---|
school | Returns information about the authenticated school | Example |
courses | Returns a paginated list of courses | Details |
course | Returns a single course by ID | Details |
students | Returns a paginated list of students | Details |
student | Returns a single student by ID | Details |
events | Returns a paginated list of calendar events | Details |
event | Returns a single event by ID | Details |
assignments | Returns a paginated list of assignments | Details |
assignment | Returns a single assignment by ID | Details |
School
The school
query returns information about the authenticated school.
Example:
query { school { id name subdomain createdAt }}
For detailed information about specific query operations, including parameters, return types, filtering options, and examples, please refer to the resource-specific documentation linked above.