TutorCruncher's API

Using TutorCruncher's API

Our API is currently in development and endpoints are being added all the time. If there is a particular piece of information you would like access to, then let us know.

To help you get started with the API we provide a browsable version of the API which can be accessed via your browser.

To view it go to https://secure.tutorcruncher.com/api/. This root page will provide a list of all API endpoints. By clicking on an endpoint, you can view the available filters.

You may also find it helpful to use Google Chrome's postman extension to make some trial requests to the API.

Curl Example

API authentication on TutorCruncher is performed using an HTTP request header including your API token. For example to get a list of appointments for your company you could make a curl request thus:

Request:

> curl -H "Authorization: token <your API token>" -H "Accept: application/json; indent=2" https://secure.tutorcruncher.com/api/appointments/

(Here the accept header is not required as application/json is default, obviously indent is only added to format the response in this example.)

Response:

{
  "count": 555,
  "next": "https://secure.dinotutors.com/api/appointments/?page=2",
  "previous": null,
  "results": [
    {
      "id": 1482049,
      "start": "2020-12-25T18:30:00Z",
      "finish": "2020-12-25T20:30:00Z",
      "units": "2.00000",
      "topic": "Friday Homework Help",
      "location": {
        "id": 7008,
        "name": "Latimer Room [Downstairs]",
        "description": "",
        "can_conflict": true,
        "role": null,
        "latitude": null,
        "longitude": null,
        "address": null
      },
      "rcras": [
        {
          "recipient": 530989,
          "recipient_name": "Bridget Jones",
          "paying_client": 511336,
          "paying_client_name": "Fionn Finegan",
          "charge_rate": "80.00"
        },
        {
          "recipient": 528437,
          "recipient_name": "Olivia",
          "paying_client": 528436,
          "paying_client_name": "Olivia Odendaal",
          "charge_rate": "80.00"
        },
        {
          "recipient": 511349,
          "recipient_name": "Frodo Junior",
          "paying_client": 511337,
          "paying_client_name": "Baggins",
          "charge_rate": "80.00"
        },
        {
          "recipient": 213373,
          "recipient_name": "Isabelle Clay",
          "paying_client": 213372,
          "paying_client_name": "Anthony Clay",
          "charge_rate": "80.00"
        },
        {
          "recipient": 401483,
          "recipient_name": "franky boyle",
          "paying_client": 401478,
          "paying_client_name": "Samuel Colvin",
          "charge_rate": "80.00"
        }
      ],
      "cjas": [
        {
          "contractor": 213390,
          "contractor_name": "Diana Lafayette",
          "pay_rate": "45.00"
        }
      ],
      "status": "Planned",
      "repeater": {
        "repeat": "Weekly",
        "every": 1,
        "repeat_on": "",
        "stops_on": "2020-12-31",
        "stops_after": 1,
        "source_apt": 1481941
      },
      "service_id": 95569,
      "service_name": "Maths SAT",
      "charge_type": "Hourly"
    },
    {
      "id": 1482048,
      "start": "2020-12-18T18:30:00Z",
      "finish": "2020-12-18T20:30:00Z",
      "units": "2.00000",
      "topic": "Friday Homework Help",
      "location": {
        "id": 7008,
        "name": "Latimer Room [Downstairs]",
        "description": "",
        "can_conflict": true,
        "role": null,
        "latitude": null,
        "longitude": null,
        "address": null
      },
      "rcras": [
        {
          "recipient": 530989,
          "recipient_name": "Bridget Jones",
          "paying_client": 511336,
          "paying_client_name": "Fionn Finegan",
          "charge_rate": "80.00"
        },
        {
          "recipient": 528437,
          "recipient_name": "Olivia (TEST)",
          "paying_client": 528436,
          "paying_client_name": "Olivia Odendaal",
          "charge_rate": "80.00"
        },
        {
          "recipient": 511349,
          "recipient_name": "Frodo Junior",
          "paying_client": 511337,
          "paying_client_name": "Baggins",
          "charge_rate": "80.00"
        },
        {
          "recipient": 213373,
          "recipient_name": "Isabelle Clay",
          "paying_client": 213372,
          "paying_client_name": "Anthony Clay",
          "charge_rate": "80.00"
        },
        {
          "recipient": 401483,
          "recipient_name": "franky boyle",
          "paying_client": 401478,
          "paying_client_name": "Samuel Colvin",
          "charge_rate": "80.00"
        }
      ],
      "cjas": [
        {
          "contractor": 213390,
          "contractor_name": "Diana Lafayette",
          "pay_rate": "45.00"
        }
      ],
      "status": "Planned",
      "repeater": {
        "repeat": "Weekly",
        "every": 1,
        "repeat_on": "",
        "stops_on": "2020-12-31",
        "stops_after": 1,
        "source_apt": 1481941
      },
      "service_id": 95569,
      "service_name": "Maths SAT",
      "charge_type": "Hourly"
    },...