Skip to content
moxon home

Hyperplanning

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

posthttps://api.moxon.dev/v4/hyperplanning
Try itpost/v4/hyperplanning
curl -X POST \  "https://api.moxon.dev/v4/hyperplanning" \  -H "Content-Type: application/json" \  -d '{}'

Send the request to see the response here.

Parameters

  • urlstringrequired

    The URL of the ICS file to use and display. Must be URL-encoded before being sent

  • detail"full" | "list"optional

    Level of detail for events (full or list)

Detail Options

OptionDescription
fullDisplays a complete summary with subject, teacher, classes, date, etc.
listDisplays all data in a list

Code Examples

Response Fields

The response format depends on the detail parameter:

detail=full

  • summarystring[]

    Array of summary elements

  • subjectstring

    Subject name

  • teacherstring

    Teacher name

  • classesstring[]

    Array of class names

  • typestring

    Event type

  • startstring

    Event start time (ISO 8601)

  • endstring

    Event end time (ISO 8601)

detail=list

  • summarystring[]

    Array of summary elements

  • startstring

    Event start time (ISO 8601)

  • endstring

    Event end time (ISO 8601)

Default (no detail parameter)

  • summarystring

    Event summary

  • startstring

    Event start time (ISO 8601)

  • endstring

    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 GitHubReport an issue

Last updated on April 21, 2026