School Reviews
Returns a list of the most recent reviews for a school or for any schools in a city. All calls for School Reviews are in this format:http://api.greatschools.org/reviews/[components]?[parameters]
Components
Components of the url describe what type of data you would like. They are separated by forward slashes.| Name | Description | Sample Values |
| school or city | Return reviews for a school or for any schools in a city | Valid values: "school" or "city" |
| state* | Two letter state abbreviation | ak CA |
| city name | Name of city, with spaces replaced with hyphens. If the city name has hyphens, replace those with underscores. | San Francisco becomes "San-Francisco"
Cardiff-By-The-Sea becomes "Cardiff_By_The_Sea" |
| gsID | Numeric id of school
This gsID is included in other listing requests like Browse Schools and Nearby Schools | 1 |
*required
Parameters
The "key" parameter is what you use to send us your API key. Other parameters are optional and used to describe how you would like to receive the data.| Name | Description | Sample Values |
| key* | Your API key | myAPIkey |
| cutoffAge | Reviews must have been published after this many days ago to be returned. Only valid for the recent reviews in a city call. | 7 |
| limit | Maximum number of reviews to return. This defaults to 5. | 10 |
*required
Examples of usage:
http://api.greatschools.org/reviews/school/CA/1?key=[yourAPIkey]
Returns 5 most recent reviews for the school in California with GreatSchools ID of 1.
http://api.greatschools.org/reviews/city/CA/Alameda?key=[yourAPIkey]&limit=10&cutoffAge=7
Returns the 10 most recent reviews for schools in the city of Alameda, CA. Only returns reviews from the past 7 days.
Sample Request
http://api.greatschools.org/reviews/city/CA/Alameda?key=[yourAPIkey]&limit=2
Returns 2 most recent reviews for schools in the city of Alameda, CA.
Sample Response
Have Questions?
To ask questions or to report bugs please email
api-support@greatschools.org. Please do not abuse our API. Review the
Terms of Use.