Skip to main content

API

Learn where you can access the TutorCruncher API here.

Written by Maahi Islam

The TutorCruncher API allows you to access all the information available in your TutorCruncher account. This section of TutorCruncher can be useful if you are looking to get an overview of a large amount of information or are looking to edit/update certain parts of the system quickly.

If you want to find out more about how the TutorCruncher API works and what you can do with it, you can access our detailed API Documentation.

You will also be using this page if you are integrating TutorCruncher with your website via the TutorCruncher Socket.

The TutorCruncher API page can be found via System > Settings > TutorCruncher API > API. Here you can view all of the integrations you have linked up with TutorCruncher, and add a new integration.

An example of an API integrations page.

What you can manage through the API

Alongside reading your data, the API can create and change most of the things you would otherwise do by hand in TutorCruncher, including:

Updates to Lessons, Jobs, Ad Hoc Charges, Locations and Tasks are partial, so you only need to send the details that are changing rather than the whole record. The API Documentation shows an example request for every create and update endpoint.

Note: You can also connect Claude or ChatGPT to TutorCruncher directly, without an API key. Read how here.

Dates and times are always UTC

Every API endpoint returns dates and times in UTC, whichever way you connect. Dates you send in a filter without a timezone are read as UTC too.

If you need a window that matches a particular day in your own timezone rather than in UTC, include the timezone offset in the dates you send. A date range filter includes the whole of the final day.

Frequently Asked Questions

What is the API Rate Limit and can I increase it?

TutorCruncher allows 100 requests per minute from any one IP address. This limit is fixed and cannot be increased.

Two things are worth knowing about how it is counted:

  • It covers all traffic from that IP address to TutorCruncher, not only API calls. If your integration runs from the same office network your team uses TutorCruncher from, their browsing counts towards the same allowance.
    ​

  • There is a second, tighter limit on requests that change data - creating, updating and deleting - on top of the overall one. Reading data is the cheaper operation.

To avoid exceeding the limit, store the results of API requests locally rather than re-fetching them, spread bulk work out rather than firing it off at once, and build in retry logic that pauses before trying again. Going over the limit returns a 429 response rather than an error from TutorCruncher itself, so your integration should handle that status and back off.

The API Documentation has a Rate limits section with the full details.

My date filter is returning different records each time I run it. Why?

Dates sent without a timezone are read as UTC. If you are filtering on a local day and your timezone is offset from UTC, the window will not line up with that day. Send an explicit timezone offset with the dates to get an exact local-day window.

Did this answer your question?