Skip to navigation
API ReferenceInstitutions

SearchInstitutions

SearchInstitutions pages through the catalogue matching every condition, by name unless order_by says otherwise, 25 a page by default. A condition on fulltext also returns the matching pages of each institution’s website in fulltext_matches.

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”: “type”, “operator”: “equals”, “value”: “DISTRICT”}, …]. The fields and the operators each allows are those of the Edulead console’s institution search: among them name, state, type, subtype, studentsTotal, idParentInstitution, grade, shapes, list and fulltext; and beaconIds ({“operator”: “in”, “value”: [“<beacon id>”, …]}) with radiusMiles ({“operator”: “equals”, “value”: 25}) for the team’s beacons’ institutions, or those within the miles of them. A comma in a value matches any of its parts (“TX,CA”).

sourceenumOptional

Set to INSTITUTIONS_SEARCH to keep the search in the caller’s search history, as the console’s directory does; empty keeps no history.

Allowed values:
order_byenumOptional

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

Allowed values:
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.

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 institutions match the conditions, over every page.