Skip to navigation
API ReferencePeople

SearchPeople

SearchPeople pages through the people matching every condition, most relevant first unless order_by says otherwise, 25 a page by default; or, with group_by, their accounts. Relevance ranks by the seniority of the role a role condition matched, the quality of the contact details and whether it is the person’s only role; without a role condition it is priority, highest first. Every person a page returns counts toward the team’s revealed contacts for the month (or billing year); a page that would take the team past its limit is refused and counts nothing.

Authentication

AuthorizationBearer

A team API key, sent as Authorization: Bearer <key>.

OR
AuthorizationBearer

The Cognito access token of a signed-in Edulead user (edulead auth login), sent as Authorization: Bearer <token>.

Headers

Edulead-TeamstringRequired

Query parameters

conditionsstringOptional<=4096 characters

A JSON array of up to 30 conditions, all of which must hold: [{“field”: “titleRole”, “operator”: “equals”, “value”: “director”}, …]. The fields and the operators each allows are those of the Edulead console’s people search: among them titleRole, titleArea, institutionType, state, studentsTotal, institutionId, territoryId, shapes, lastSeen and fulltext. A comma in a value matches any of its parts (“TX,CA”). Institution conditions hold on one and the same institution of a person, role conditions on one and the same role; a role exclusion holds on every role.

sourceenumOptional

Set to keep the search in the caller’s search history, as the console does: PEOPLE_SEARCH from people search, INSTITUTION_DETAIL from an institution’s people, MAP_VIEW from the maps, BUYING_GROUPS from buying groups.

Allowed values:
order_byenumOptional

Sort order: a sortable field name, optionally followed by ” desc”. The allowed values are listed.

page_sizeintegerOptional0-100
Number of items per page, at most the maximum shown. Omitted or 0 means the RPC's default page size.
page_tokenstringOptional<=1024 characters

Opaque token from a previous response; empty for the first page.

group_byenumOptional

account pages through the people’s accounts instead, the most important first, each with its most valuable people in groups; order_by is ignored.

Allowed values:
people_per_groupintegerOptional0-100

With group_by, how many people each account carries; 0 is 10.

Response

Success
itemslist of objectsOptional
The page of results, in the requested order.
next_page_tokenstringOptional

Token for the next page; empty when this is the last page.

total_sizestringOptionalformat: "int64"

How many people match the conditions, over every page; with group_by, how many accounts.

district_countstringOptionalformat: "int64"
How many districts the matching people belong to.
groupslist of objectsOptional

With group_by, the page of accounts.

person_totalstringOptionalformat: "int64"

With group_by, how many people match over every account.

account_size_histogramlist of objectsOptional

With group_by and a condition selecting public institutions, how many matching accounts fall in each size band, counted without any accountNrStudents condition.