Does SchoolMint Grow offer an open API?

Learn how users with Network permission can access Grow's open API.

Please note: this article is primarily for users with a System Admin role.

Grow offers an open REST API that can be accessed directly by district partners and by other applications working with the district as needed. The API can both push and pull data from Grow, and offers extensive flexibility in terms of setup, timelines for pushes and pulls, and ongoing changes to the parameters of the data being pulled. The API is our preferred method for data transfer and integrations.

Accessing the API

You can get to our API documentation by clicking Tools > API Documentation.

This documentation will walk through the various endpoints and provide sample scripts for commonly pulled data.

If you need access to the API, you can find an API key by clicking on your name in the top right corner and then Client Auth Management.

Then, press the green New Client button in the top right corner. 

On this page, you can create a new client, which will generate a client ID and client secret. These are the credentials you will use to request an access token. Once you have this token, you can use it to make requests against authenticated endpoints. These access tokens are valid for 24 hours. So, you only need to authenticate once per day in order to use the API.

 

Do you need more information?

Click the Support and Feedback button or email us at [e-mail]