The SchoolsBuddy Public API allows schools to securely connect SchoolsBuddy with their own internal or third-party systems. This enables schools to automate workflows, manage large volumes of data efficiently, and build custom integrations tailored to their specific operational needs.

This first phase of the API focuses on core user and activity management, providing a scalable and flexible way to interact with SchoolsBuddy programmatically. Access is strictly controlled by Organisation Super Admins to ensure integration security.

Overview

The SchoolsBuddy Public API is designed to reduce manual data entry and synchronize data across your school's ecosystem. Common usages include automating bulk administrative tasks and integrating SchoolsBuddy with custom or internally built MIS/SIS platforms.

Key Concepts / What’s New

The Phase 1 release includes endpoints for core data entities including Students, Contacts, Staff, Groups, Events, and Locations.

Key Capabilities in Phase 1:

• Activity Management: Create locations for school activities and basic groups for Sports/Trips event creation or quick fee charging.
• Data Maintenance: Manage group members and archive groups in bulk at the end of an activity program.
• External Records: Add and manage students or external staff (like guest facilitators or coaches) that are not available in your school's SIS.
• Reporting & Synchronization: Export activity data by student or event for use in external dashboards to analyze engagement and equity.

Step-by-Step Navigation

Requesting Initial Access

1. Contact the SchoolsBuddy Support team at support@schoolsbuddy.com to request API access.
2. The team will enable API access for your school and provide necessary technical documentation.
3. Once enabled, the API Manager will be activated in your SchoolsBuddy site.

Once your API access has been enabled, follow this guide to set up your API client: How to Set Up the SchoolsBuddy Public API.

Tips & Best Practices

• Security First: Use the OAuth 2.0 authentication standard provided to ensure secure access to your data.
• Review Documentation: Developers should access the Integrations Portal and the Swagger page for full endpoint specifications and authentication guidance.
• Efficiency: Utilize pagination metadata for efficient data retrieval when dealing with large datasets.

Warnings & Important Notes

Endpoints for managing more complex groups (such as Instant Book and Preference Signups) are not in the initial release but are scheduled for a future phase.

Related Articles

• How to Set Up the SchoolsBuddy Public API
• Managing Organisation Super Admin Permissions

Frequently Asked Questions

What authentication method is used?

The API utilizes OAuth 2.0 authentication to ensure modern security standards for all integrations.

Is technical documentation available?

Yes, comprehensive developer documentation, including OpenAPI/Swagger definitions, is provided upon request or via the Integrations Portal.

In Summary

• The API connects SchoolsBuddy with internal or third-party systems to automate data workflows.
• Phase 1 focuses on Students, Staff, Groups, and Events management.
• Access must be enabled by Support to begin integration.

Enhance your school's operational efficiency with the SchoolsBuddy Public API.