GET https://ed.link/api/v2/institutions
Retrieve a list of public Institutions.
You must provide an application's publishable key (pk_...) as a bearer token to access this endpoint.
Request Parameters
This query allows for standard paging parameters.
It is best practice to use either $first or $last in conjunction with the $next value returned by the API to paginate through results.
Read More About Paging
Developer Guide
This query allows for filtering results.
Read More About Filtering
Developer Guide
This query also allows for fuzzy searching.
| Parameter | Type | Description |
|---|---|---|
$search | string | A search term used to fuzzy-match institutions by name and by address city, state, or postal code. Results are ordered by name similarity. Cannot be combined with cursor pagination ($after or $before). |
$offset | integer | Offset for paginating $search results. Defaults to 0. Ignored without $search. |
$expand | string | A comma separated list of relationships to join onto the parent entity |
When browsing with $search use $offset to page through results instead of $after or $before.
Sample Request
// List institutions.
axios.get('https://ed.link/api/v2/institutions', {
headers: {
authorization: `Bearer ${publishable_key}`
}
});
// Search for institutions matching "Lincoln".
axios.get('https://ed.link/api/v2/institutions', {
params: {
$search: 'Lincoln',
$first: 25
},
headers: {
authorization: `Bearer ${publishable_key}`
}
});
Sample Response
{
"$data": [
{
"id": "00000000-0000-0000-0000-000000000000",
"name": "Lincoln Elementary School",
"type": "school",
"descriptor": null,
"website": "https://lincoln.example.edu",
"description": "A public elementary school serving grades K-5.",
"logo": null
},
{
"id": "11111111-1111-1111-1111-111111111111",
"name": "Lincoln High School",
"type": "school",
"descriptor": null,
"website": "https://lincoln-high.example.edu",
"description": null,
"logo": null
}
],
"$next": "https://ed.link/api/v2/institutions?$cursor=...",
"$request": "00000000-0000-0000-0000-000000000000"
}