Find people associated with a school

Find people associated with a school.


Acting Customer Yes
Acting User Yes

HTTP Methods

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

GET Execute query


Parameters optional unless specified

Name Description Required?
user_id ID of user to query as. Yes
SCHOOL_ID ID of school to anchor on. Yes
REL_TYPE Optionally, return only those people associated by the specified relationship type. For valid values, see the entities attribute of the school object.

If you want to search within results, type of search to execute. Valid values:

people Search for people whose idenitty data (name, email, screen name, etc) match the criteria.
relevance Search for people who are relevant for the given query based on their newtork profiles, content, and activity.

If you want to search within results, 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.

name Person's name
screenName Person's screen name
email Person's email
profileText Person's profile text (note this is not searched by default)
relationship Person's relationship to querying user (note this is not searched by default)
field_<name> Filter the query for a specific value for a specific field. Fields are as specified for the fields parameter above.
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)
union If you want to find people connected to more than one school, you can pass a comma-separated list of additional school IDs in this parameter.
include_network_data 'true' to have the raw network data for the person's network identity(ies) included in the response
num If querying list of users, can specify the number to return.
page If querying list of users, specify the page to return (1-based).
detailed_results 'true' to return detailed person objects, rather than the default compact ones.
sort Attribute to sort on (of person object)
sort_direction desc or asc


Search Results object.