Build Custom Integrations With The Teachworks API

Build Custom Integrations With The Teachworks API

The Teachworks API makes it possible to work more efficiently by building custom integrations and software applications using the data from your Teachworks account. Whether you’re looking to link your Customer Relationship Management (CRM) software with Teachworks to manage sales leads, or add a map search to your website for easy student-tutor matching, the API provides a way to achieve this.

In this article, we’ll provide an overview of the Teachworks API, look at some examples of potential uses for your tutoring business, and provide a quick summary of the latest API updates.

The Teachworks API: An Overview 

Generally speaking, an API is an Application Programming Interface that provides a way for different software programs to communicate and share data with each other. It allows developers to build external applications without needing to know how a system (such as Teachworks) works internally. 

The Teachworks API allows you and your developers to programmatically access information in your account, such as lesson or student data, to create external tools. Our API features more than 65 endpoints that support different functions. For example, endpoints related to “Students” support:

  • Retrieving a specific student’s data
  • Retrieving a specific student’s lesson totals
  • Retrieving a list of students 
  • Creating a Child Student
  • Creating an Independent Student
  • Updating custom field values (for fields created through the Custom Fields Add-on)
  • Updating Child Student profiles
  • Updating Independent Student profiles

Main features of the Teachworks API:

  • Developers can use the API to extend the functionality of your Teachworks account – this makes it possible to create custom tools much faster since they are not building an application from scratch.
  • Our API is very well documented with clear instructions and examples. The documentation is updated each time a new endpoint or update is added.
Teachworks API - Documentation
  • Our API features a myriad of endpoints already and we are always adding additional endpoints based on demand. You can access information related to Locations, Services, Employees, Customers, Students, Lessons, Tutor Availability, Invoices, Payments and much more.
  • Our support team is always ready to help with any questions you and your developers may have when development is underway.
  • Our API enforces secure access with authentication and authorization to prevent unauthorized access.

Possible Custom Solutions For Your Tutoring Business

Your Teachworks account houses a lot of data related to clients, students, employees, lessons, wage information, invoices, payments and more. The API provides access to this information to allow you to build just about any application you may need to work more efficiently. Below are some examples:

  • If you’re using a CRM like Salesforce to manage sales leads, you can use the Teachworks API to add profiles for these clients in Teachworks automatically.  
  • If you’re using a payment processor other than Stripe, you can use the API to record payments in Teachworks. These can be allocated to the corresponding invoices to mark them as “Paid”. Teachworks already offers full integration with Stripe that you can read more about here: Stripe Integration.  
  • If you would like to add a booking solution to your website that allows students to search for tutors in their area, you can use the API to pull location data on employee profiles. The API supports lesson creation, so you can also add the booked lessons to Teachworks automatically.
  • You can pull employee hours and earnings from your Teachworks account to use with payroll software of your choice. Once payroll has been completed, compensation (such as lesson wages, bonuses and reimbursements) can be posted to your Teachworks account to keep records updated. 

The Latest Teachworks API Updates

We are always adding more functionality to the API based on the feedback we receive from our clients. Below is a quick overview of the latest fixes, updates and endpoints we’ve added over the last few months:

  • Added a custom status filter for the teacher lesson totals endpoint.
  • Added a new “Retrieve Student Lesson Totals” endpoint that returns a student’s total lesson count or duration.
  • Changed the order for the custom field parameter for profile endpoints and new Zapier triggers.
  • Updated the List Lessons endpoint to accept the gt, gte, lt, and lte values for the “to_date” filter parameter.
  • Added the ability to create Requested lessons.

Comments are closed.

Start Free Trial