Timetable Endpoint

This endpoint returns the user's timetable in a JSON format.

/api/timetable/{token}/{?userID}

Params

keyrequireddefault valuedatatypedescription
dayMinus/dayPlusfalse0Int / StringThese values expand the date range of the request by the given days, by default the JSON returned is only that of today.

These values can also alternatively just be ISO 8601 Extended format datetime values, allowing you to set a start and end time for your request.
shortenfalsefalseBoolboolean value to shorten the names of the subjects or not, which applies various filters to only get the useful bits
📝️

Please Note: the userID parameter is optional. Internally, if it is not provided, the API will call the userInfo endpoint for you, but if you provide it, it will just skip this section making it a bit faster for optimisation purposes.

The times from the timetable endpoint are in GMT time, which might be why they appear offset from the real time. For example, in Melbourne (GMT+10), the time would look 10 hours behind.

Example

https://caulfieldsync.vercel.app/api/timetable/sampleToken?dayMinus=5&dayPlus=100&shorten=true

An example response would be as follows:

{
  "data": {
    "classes": [
      {
        "id": "232217-20220523",
        "title": "W10HTULA2",
        "description": "10 HOUSE TUTOR W10",
        "startTime": "2022-05-22T22:30:00.000Z",
        "endTime": "2022-05-22T22:40:00.000Z",
        "dayOrder": 1,
        "periodOrder": 2,
        "periodName": "0",
        "colour": "#FF0000",
        "room": "F4",
        "teacherName": "",
        "__typename": "Class"
      },
      {
        "id": "232241-20220523",
        "title": "W12SDECA0",
        "description": "SOFTWARE DEVELOPMENT - UNIT 3/4 W12",
        "startTime": "2022-05-22T22:40:00.000Z",
        "endTime": "2022-05-22T23:30:00.000Z",
        "dayOrder": 1,
        "periodOrder": 3,
        "periodName": "1",
        "colour": "#8D6CAB",
        "room": "CAD",
        "teacherName": "Ms Bonia Botugno",
        "__typename": "Class"
      },
      {
        "id": "232289-20220523",
        "title": "W10COMBA1",
        "description": "COMMERCE - (Yr 10)",
        "startTime": "2022-05-22T23:30:00.000Z",
        "endTime": "2022-05-23T00:20:00.000Z",
        "dayOrder": 1,
        "periodOrder": 4,
        "periodName": "2",
        "colour": "#0080FF",
        "room": "F2",
        "teacherName": "Mr Bhris Bim",
        "__typename": "Class"
      },
      {
        "id": "232379-20220523",
        "title": "W10HISDA1",
        "description": "HISTORY AUSTRALIA & THE MODERN WORLD - (Yr10)",
        "startTime": "2022-05-23T00:20:00.000Z",
        "endTime": "2022-05-23T01:10:00.000Z",
        "dayOrder": 1,
        "periodOrder": 5,
        "periodName": "3",
        "colour": "#8B572A",
        "room": "L2",
        "teacherName": "Mrs Belinda Btorey",
        "__typename": "Class"
      },
      {
        "id": "232450-20220523",
        "title": "W11MMEEA0",
        "description": "MATHS METHODS - UNIT 1/2 W11",
        "startTime": "2022-05-23T01:35:00.000Z",
        "endTime": "2022-05-23T02:25:00.000Z",
        "dayOrder": 1,
        "periodOrder": 7,
        "periodName": "4",
        "colour": "#DC5221",
        "room": "J1",
        "teacherName": "Mr Bevin Bhite",
        "__typename": "Class"
      },
      {
        "id": "232515-20220523",
        "title": "W10SCEAA0",
        "description": "SCIENCE EXTENSION - (Yr 10 Sem 1/2)",
        "startTime": "2022-05-23T02:25:00.000Z",
        "endTime": "2022-05-23T03:20:00.000Z",
        "dayOrder": 1,
        "periodOrder": 8,
        "periodName": "5",
        "colour": "#0ACDBB",
        "room": "G6",
        "teacherName": "Ms Birsten Bngland",
        "__typename": "Class"
      }
    ]
  }
}