GET https://ed.link/api/v2/institutions/:institution_id
Retrieve a public Institution and its immediate child institutions.
You must provide an application's publishable key (pk_...) as a bearer token to access this endpoint.
Request Parameters
| Parameter | Type | Description |
|---|---|---|
institution_id | string | The UUID of the desired Institution. |
The response includes the requested institution with its addresses populated, along with any institutions that are direct children of it in the public dataset. Each child institution also includes its addresses.
Sample Request
axios.get('https://ed.link/api/v2/institutions/00000000-0000-0000-0000-000000000000', {
headers: {
authorization: `Bearer ${publishable_key}`
}
});
Sample Response
{
"$data": {
"institution": {
"id": "00000000-0000-0000-0000-000000000000",
"name": "Springfield School District",
"type": "district",
"descriptor": null,
"website": "https://springfield.example.edu",
"description": "A public school district.",
"logo": null,
"addresses": [
{
"id": "22222222-2222-2222-2222-222222222222",
"type": "physical",
"street": "500 Education Way",
"unit": null,
"postal_code": "62701",
"city": "Springfield",
"state": "IL",
"country": "US",
"latitude": 39.7817,
"longitude": -89.6501
}
]
},
"children": [
{
"id": "44444444-4444-4444-4444-444444444444",
"name": "Lincoln Elementary School",
"type": "school",
"descriptor": null,
"website": "https://lincoln.example.edu",
"description": "A public elementary school serving grades K-5.",
"logo": null,
"addresses": [
{
"id": "33333333-3333-3333-3333-333333333333",
"type": "physical",
"street": "123 Main Street",
"unit": null,
"postal_code": "62701",
"city": "Springfield",
"state": "IL",
"country": "US",
"latitude": 39.7817,
"longitude": -89.6501
}
]
},
{
"id": "55555555-5555-5555-5555-555555555555",
"name": "Lincoln High School",
"type": "school",
"descriptor": null,
"website": "https://lincoln-high.example.edu",
"description": null,
"logo": null,
"addresses": [
{
"id": "66666666-6666-6666-6666-666666666666",
"type": "physical",
"street": "456 South Parkway",
"unit": null,
"postal_code": "62729",
"city": "Springfield",
"state": "IL",
"country": "US",
"latitude": 78.2516,
"longitude": -29.1351
}
]
}
]
},
"$request": "00000000-0000-0000-0000-000000000000"
}