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 a variety of query operations to retrieve data from your school. This section documents all available queries, along with concepts like pagination and filtering that apply across multiple query types.

Core Concepts

• Pagination: Learn how to work with paginated responses for large datasets
• Filtering: Understand how to filter query results to get exactly what you need

Available Resources

The API provides queries for the following resources:

• Courses: Access course information
• Students: Retrieve student data
• Assignments: Get assignment details
• Events: Access school calendar events
• Coupons: Retrieve discount coupon information
• Membership Plans: Access subscription plan details
• Payments: Query payment transactions and refunds
• Subscriptions: Retrieve user subscription information
• Users: Retrieve user information

Common Parameters

Paginated list queries accept the following common parameters:

Parameter	Type	Description
page	Int	1-indexed page number to retrieve (default: 1)
perPage	Int	Items per page (default: 20, maximum: 50)
limit	Int	Deprecated alias for perPage; prefer perPage

For full details, see Pagination.

Basic Example

Here’s a simple example of querying for school information:

query {
  school {
    id
    name
    createdAt
  }
}

For more detailed examples and resource-specific queries, explore the resource pages linked above.