This article is intended for IT Admin users.
What is the API?
The Clipboard API allows you to access a variety of data from your school's Clipboard account, allowing you to build integrations, apps and other services using the wealth of extracurricular data. Please see our API Documentation here for resources on our endpoints.
How do I extract the data required from the API?
You can extract the required data using our API endpoint, which is included in your Clipboard subscription. This would involve building a custom solution on your end to handle the data extraction process.
Can I use the API to add Users?
⚡️ Provision Users Automatically via API: This functionality now arms IT teams with the tools to build auto-provisioning and de-provisioning of staff in Clipboard based on another system, like an HR system. |
This eliminates the need for manual data entry, reducing the likelihood of errors and saving time. Schools can tailor this tool to their specific needs, making it more efficient and streamlined for managing user information.
You may also use the API to add Pre-Explained Absences and Sessions to Clipboard (currently in early release. Please contact Clipboard Support to enable this feature).
Can I use the API to write back to the SIS?
Yes! We have a number of schools using Clipboard's API to write back Clipboard data to their SIS or other school systems.
Can Clipboard write back to my SIS?
Unfortunately, no SIS currently supports direct write-back functionality into their system from Clipboard. This limitation is due to the framework provided by all SISes. If you require this capability, I recommend reaching out to your SIS provider directly to request this feature. It's worth noting that many schools have expressed interest in such functionality.
How do I use the API to display my Clipboard Fixtures?
To present all of your Fixtures to your school community, Digistorm has recently built a "Fixtures Widget", a webpage that they’ve implemented for a number of schools. The page gets its data from the Clipboard API . It’s a great way for you to be able to show all Fixtures at the school in one place in addition to the personalised Digistorm experience.
It is also branded for the school. This is something Digistorm has been developing with Clipboard schools. Please reach out to your contact at Digistorm if you'd like to explore this further.
How do I use the API to display an overview of my Clipboard schedule to the school?
We have schools that extract the Clipboard Schedule using our API. We recommend checking out the format=ics parameter. You would receive an endpoint for the sessions; they would just be paginated with limited details. See the example in the below image.
Then you must subscribe to a webcal feed for all Activities or just specific Departments. As the basic calendar sync is specific to a user allocated to a Session rather than the overall Clipboard Schedule.
How do I use the API to create an “All Sessions” feed?
If you need a single calendar showing all Staff Sessions, you’ll need to build your own custom ICS solution via our REST API as we currently do not support that:
Fetch all sessions as JSON
Example GET https://api.clipboard.app/sessions (with your required options) Authorization: Bearer <YOUR_TOKEN>
2. Convert JSON to iCal
3. Host the generated .ics
Upload the file to a publicly-accessible URL.
4. Subscribe your calendar
In Outlook, Apple Calendar, or Google Calendar, add a new subscription pointing at your hosted .ics URL