The Teachworks API is an application programming interface that allows you to access the data in your Teachworks account in order to develop custom integrations and software.
NOTE: API access is only available to companies on the "Growth" and "Premium" subscriptions.
If you are using the legacy pricing, it is only available on the 400+ plan.
Enabling the API
Click on "Account & Settings" and then click on "Integrations & Add-ons".
Use the "Search" field on the right and enter "API'.
Click on the "Enable" link.
Usage
After you have enabled the API, you can click on the "Manage" link. You can generate your Teachworks API token by clicking on the "Generate API Token" button.
You will use this key to access your account through the API. Protect this key like a password and do not include it in any public web pages (it should be used on the server-side for public facing web pages).
You can also click on the "Create Sandbox Account" button if you'd like to create a sandbox account for testing your API integration before connecting it to your company's live account.
API Documentation
You can find the documentation for our API here: Teachworks API Docs. We will be adding additional endpoints to the API for accessing additional types of data and managing records.
If you are interested in an endpoint that isn't currently available, please contact us at support@teachworks.com and we will look into adding it.