Search Schools

Search for schools.


Acting Customer Yes
Acting User Yes

HTTP Methods

If a method is not listed, it is not supported for this call

GET Execute search


Parameters optional unless specified

Name Description Required?
user_id ID of user to query as. Yes

Search query. Defaults to parsing natural language query. For more advanced queries, can include exact phrases surrounded by double-quotes ('"') and can precede required terms/phrases by a plus ('+') sign.

For expert level queries, can specify an exact query in Lucene query syntax and include the literal_context parameter.

literal_syntax 'true' to pass an exact Lucene-compatible query to be interpreted literally. (Note: for relevance queries with literal syntax, use text as the query attribute name)
num Number of results to return.
page Page of results to return (1-based).
detailed_results 'true' to return detailed school objects, rather than the default compact ones.


Search Results object.