Hyperplanning

The /hyperplanning endpoint allows you to display a Hyperplanning schedule information in JSON format from an ICS (calendar) file.

posthttps://api.moxon.dev/v3/hyperplanning

Parameters

urlstringrequired
The URL of the ICS file to use and display. Must be URL-encoded before being sent
detailstringoptional
Level of detail for events (full or list)

Detail Options

Option	Description
`full`	Displays a complete summary with subject, teacher, classes, date, etc.
`list`	Displays all data in a list

Request Example

Request

curl -X POST -d "url=https%3A%2F%2Fexample.com%2Ffile.ics&detail=full" "https://api.moxon.dev/v3/hyperplanning"

Response

[
    {
        "summary": ["Mathematics", "DOE", "Class", "1", "Class", "2"],
        "subject": "Mathematics",
        "teacher": "DOE",
        "classes": ["Class 1", "Class 2"],
        "start": "2000-03-01T12:00:00.000",
        "end": "2000-03-01T14:00:00.000"
    }
]

Response Fields

Field	Description
`summary`	Array of summary elements
`subject`	Subject name
`teacher`	Teacher name
`classes`	Array of class names
`start`	Event start time (ISO 8601)
`end`	Event end time (ISO 8601)

Error Handling

If parameters are missing or invalid, the API will return an error:

400Please provide a valid ICS file URL (?url={URL})The url parameter is missing or invalid

Edit this page on GitHub Report an issue

Last updated on April 8, 2026