Search

Enabling ManageBac+ Public API for Integrations

The ManageBac+ Team
The ManageBac+ Team
  • Updated

ManageBac+ Public API

Learn how the ManageBac+ public API works, how to create and manage API tokens, and where to find supported fields, functions, permissions, notes, and changelog information.

The ManageBac+ public API allows schools to connect their ManageBac+ account to external platforms that are not directly integrated with ManageBac+.

Only an administrator on your school’s account can configure these settings. This guide covers setup, token management, supported functions, technical notes, permissions, and frequently asked questions.

Settings > Develop > API Manager > Add New Token
Navigate to API Manager to create and manage ManageBac+ public API tokens.

Overview

The ManageBac+ public API is designed for schools that need to build custom connections with third party systems. API access is controlled through tokens created and managed by administrators.

From the API Manager, you can create tokens, control permissions, review token status, access reference documentation, and view the API changelog.

Key Concepts / What’s New

Supported fields and functions

Open the Reference Docs tab from the left menu for detailed guidance on setting up API connections, including notes with sample requests and responses. This page also includes a version dropdown at the top so you can use the available requests listed for different API versions.

Reference Docs tab in API Manager
Use the Reference Docs tab to review supported requests, sample responses, and version specific API details.

API permissions

For permission fields, you can choose None, select only those with Read-only rights, or select All. You can also select individual fields by ticking the checkbox.

Students

  • index
  • show
  • create
  • update
  • archive
  • unarchive

Parents

  • index
  • show
  • create
  • update
  • archive
  • unarchive

Teachers

  • index
  • show
  • create
  • update

Year Groups

  • index
  • advisors
  • students
  • add-students
  • remove-students
  • term-attendance
  • date-attendance

Classes

  • index
  • show
  • students
  • add-students
  • remove-students
  • term-attendance
  • date-attendance

Class assessments

  • gradesterm-grades

Memberships

  • index

School

  • show
  • academic-years
  • subjects
  • grades

Tasks

  • indexshowstudents

API functions

Year Groups

  • Get all Year Groups
  • Get Advisors
  • Get Students for a Year Group
  • Add Students to a Year Group
  • Remove Students from a Year Group
  • Get Homeroom Attendance for a Year Group and Term
  • Get Homeroom Attendance for a Year Group on a specified Date

Classes

  • Get all Classes
  • Get a Class
  • Get Students for a Class
  • Add Students to a Class
  • Remove Students from a Class
  • Get Tasks for a Class
  • Get a Task for a Class
  • Get Student Assessment Results for a Task and Class
  • Get Term Grades for a Class
  • Get all Grades for a Class during an Academic Term
  • Get Attendance for a Class during an Academic Term
  • Get Class Attendance for a Date

Memberships

  • Get all Memberships

Students

  • Get all Students
  • Get a Student
  • Create New Student
  • Update a Student
  • Archive a Student
  • Unarchive a Student

Teachers

  • Get all Teachers
  • Get a Teacher
  • Create New Teacher
  • Update a Teacher

Parents

  • Get all Parents
  • Get a Parent
  • Create New Parent
  • Update a Parent
  • Archive a Parent
  • Unarchive a Parent

School

  • Get School Details
  • Get Academic Years
  • Get School Grades
  • Get School Subjects

Utilities

  • Ping
  • Get Avatar

API changelog

You can view the API changelog in ManageBac+ by navigating to Settings > Develop > API Manager. At the bottom of this page, you will find the Changelog section, where recent API updates are listed chronologically, including new fields, added or modified endpoints, and other relevant technical changes.

Changelog section in API Manager
Review the changelog in API Manager to track recent API updates and technical changes.

Step by Step Navigation

Enable the ManageBac+ public API and add a token

  1. Navigate to Settings > Develop > API Manager > Add New Token.
  2. Click Add New Token.
  3. Enter a clear and useful token name so it is easy to identify what the token is used for.
  4. Select the points you want to update and retrieve, including Student, Parent and Teacher data, IB Groups, Classes, and School settings.
  5. Click Add Token to generate the token.
API Manager navigation path
Open API Manager from the Develop section in Settings.
Add New Token configuration screen
Choose a token name and select the permissions required before creating the token.

Edit or manage an API token

  1. Open Settings > Develop > API Manager.
  2. Use the clipboard icon to copy the token for use in another trusted system.
  3. Hover over the i icon to view the token permissions.
  4. Review the token status to see whether it is enabled or disabled.
  5. Click Edit to adjust permissions or disable or enable the token.
  6. Delete the token using the rubbish bin icon when the integration is no longer needed.
Existing API token with actions to copy, edit, and delete
Manage existing tokens by copying, reviewing, editing, enabling, disabling, or deleting them.

Warnings & Important Notes

Security warning

Your API token should only be shared with trusted parties. API tokens should never be sent by email or saved on forms without SSL encryption. Once an integration is no longer in use, we recommend disabling the API token by clicking the delete icon.

API token controls including delete option
Keep tokens secure and remove them when they are no longer required.

API notes

  • Null values are never rendered.
  • Null values are ignored in POST requests.
  • Empty string values are not ignored and will overwrite existing values.
  • Any call will return an error when it cannot find a user for mass assignment, for example parent_ids or child_ids.
  • Parameters available for index actions stack using AND logic. Using modified_since and deleted_since at the same time may not return the expected result because deletion does not change the record modification timestamp.
  • Any users who have the admin role are read-only through the API for security reasons.
  • All timestamp fields are in ISO8601 format, for example yyyy-mm-ddThh:mm:ss.sssTZ such as 2017-11-06T04:35:00.000GST.
  • If you have questions or concerns about the API, please contact api@managebac.com.

Rate limit

The API request limit is 200 requests per minute from the same IP address.

Frequently Asked Questions

Does ManageBac+ integrate with another platform?

If the product is not listed under Settings > Integrations > Partners, then there is no formal relationship. In these cases, your school may still be able to establish a custom integration by using the public API.

Can ManageBac+ Support build an integration for our school?

Let us know which system you would like to integrate with ManageBac+, and we will consider whether it makes sense for us as a company and product to become a direct partner with that tool or service.

Can ManageBac+ Support write the API request for us?

The ManageBac+ Support team can provide guidance on API questions and issues, but all API requests must be completed directly by your school. If you are establishing a custom connection, please consult your IT department.

What is the ManageBac+ API rate limit?

The API request limit is 200 requests per minute from the same IP address.

Where can I find guidance on how to use the ManageBac+ public API?

Please refer to Settings > Develop > Reference Docs for details on each field and the latest changelog notes.

My API request has an issue. Who should I contact?

Please email api@managebac.com with clear details of the request and the error you are experiencing.

In Summary

  • The ManageBac+ public API allows schools to connect ManageBac+ with external systems through administrator managed tokens.
  • You can create, review, edit, disable, and delete tokens from Settings > Develop > API Manager.
  • Reference Docs, permissions, API notes, changelog details, and common support guidance are all available within the API Manager workflow.

ManageBac+ gives schools a controlled way to build custom integrations while keeping API access secure and permission based.

Share

Was this article helpful?

9 out of 16 found this helpful