You can use Teach ’n Go’s API to gather data about your school — including students, classes, lessons, attendance, and payments.
This guide lists all available API endpoints and explains how to authenticate and make requests using your school’s unique API key.
How to Create Your API Key
Before making any API requests, you’ll need to create an API key for your school.
Go to your School Settings page.
Click on the Developers tab.
Click Create an API Key.
This key will authenticate your requests and allow secure communication between your system and Teach ’n Go.
Using the API key
You can use your API key in one of two ways:
Option 1: Include it in the header
X-API-KEY: your_api_key_here
Example:
curl -X POST "https://app.teachngo.com/api/student" \
-H "X-API-KEY: your_api_key_here"
Option 2: Add it as a query parameter
https://app.teachngo.com/api/student?apikey=your_api_key_here
This method is helpful for quick testing or when integrating with tools that don’t support custom headers.
Request method and body
Method: POST
Body type: JSON
You can also control the number of records returned per page using the per_page parameter (default is 20).
{
"per_page: 200
}
API endpoints
Below is a list of available endpoints for retrieving school data.
Use your API key for authentication with each request.
🧑🎓 Student list
Returns: All students in your school and their related information.
Endpoint:
https://app.teachngo.com/globalApis/student_list
🧑💼 Prospect list
Returns: All prospective students and their information.
Endpoint:
https://app.teachngo.com/globalApis/prospect_list
📚 Course list
Returns: All courses in your school and related details.
Endpoint:
https://app.teachngo.com/globalApis/course_list
🗓 Lesson list
Returns: All lessons for a specific course.
Endpoint format:
https://app.teachngo.com/globalApis/lesson_list/[course_id]
Replace [course_id] with the actual course ID from your course list.
Each record includes lesson details, schedule, and assigned teachers.
🏫 Student attendance
Returns: Complete attendance information for all students.
Endpoint:
https://app.teachngo.com/globalApis/students_attendance
Use this to analyze attendance rates or build custom attendance reports.
💬 Student behaviours
Returns all information regarding student behaviour.
https://app.teachngo.com/globalApis/student_behaviours
🧾 Receipts
Returns: Receipt information for your school.
Endpoint:
https://app.teachngo.com/api/v1/receipts
You can specify a date range to retrieve receipts issued between two dates.
Example body:
{
"from_date: YYYY-MM-DD",
"to_date: YYYY-MM-DD"
}
💰 Payments
Returns: Details about all payments and their current status.
Endpoint:
https://app.teachngo.com/api/v1/payments
Example workflow
Here’s a typical use case for combining these endpoints:
Retrieve your course list → /globalApis/course_list
Choose a course ID → e.g., 57645
Retrieve lessons for that course → /globalApis/lesson_list/57645
Retrieve enrolled students → /globalApis/student_list
Cross-reference attendance → /globalApis/students_attendance
This approach lets you create your own dashboards or custom reports outside Teach ’n Go — all powered by live data from your school.
Best practices
Keep your API key secure — treat it like a password.
Use the per_page parameter to manage data loads efficiently.
Store only the data you need to comply with privacy regulations.
If integrating with external systems, refresh your data periodically to ensure accuracy.
FAQs
1. Can I use the same API key for multiple integrations?
Yes, but it’s best practice to create separate keys for each integration to track usage and revoke access easily if needed.
2. How often is the data updated?
Data is retrieved in real time from your Teach ’n Go account.
3. Can I filter data (e.g., by date or course)?
Currently, most endpoints return full datasets. You can apply filters in your own system after retrieval.
4. What’s the default page size for results?
By default, 20 records are returned per page. You can increase this using "per_page": 200.
5. Do I need admin rights to use the API?
Yes, only users with admin permissions can create or use API keys.
Conclusion
With these endpoints, you can easily integrate Teach ’n Go data into your own systems — from dashboards and CRMs to reporting and automation tools.
Start by generating your API key, test a few endpoints, and build the integrations that make your school run smarter and faster.