> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://docs.getedulead.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getedulead.com/_mcp/server. # GetInstitution GET https://api.getedulead.com/v4/institutions/{id} GetInstitution returns one institution of the catalogue by id, with the email domains its staff use and the address formats seen on each. Reference: https://docs.getedulead.com/api-reference/institutions/get ## Authentication - `Authorization` header (bearer token, required) — A team API key, sent as `Authorization: Bearer `. - `Authorization` header (bearer token, required) — The Cognito access token of a signed-in Edulead user (`edulead auth login`), sent as `Authorization: Bearer `. ## Request ### Path parameters - `id` (string, required) — Identifier of the resource, assigned by Edulead and opaque to callers. ## Response ### 200 Success - `institution` (edulead.v4.Institution, optional) — Institution is one institution of the catalogue, as the search index holds it. Zero values are omitted: a count of 0 and an unknown count look the same. ## Types ### edulead.v4.Institution Institution is one institution of the catalogue, as the search index holds it. Zero values are omitted: a count of 0 and an unknown count look the same. - `id` (string, optional) — Identifier of the resource, assigned by Edulead and opaque to callers. - `name` (string, optional) - `type` (enum, optional) — InstitutionType is what kind of institution it is. - Allowed values: `INSTITUTION_TYPE_UNSPECIFIED`, `INSTITUTION_TYPE_DISTRICT`, `INSTITUTION_TYPE_SCHOOL`, `INSTITUTION_TYPE_AGENCY`, `INSTITUTION_TYPE_UNION`, `INSTITUTION_TYPE_PARENT_ORG`, `INSTITUTION_TYPE_SELPA` - `subtype` (enum, optional) — InstitutionSubtype refines the type, as NCES classifies it. - Allowed values: `INSTITUTION_SUBTYPE_UNSPECIFIED`, `INSTITUTION_SUBTYPE_REGULAR`, `INSTITUTION_SUBTYPE_CHARTER`, `INSTITUTION_SUBTYPE_SERVICE`, `INSTITUTION_SUBTYPE_SPECIALIZED`, `INSTITUTION_SUBTYPE_OTHER`, `INSTITUTION_SUBTYPE_SUPERVISORY`, `INSTITUTION_SUBTYPE_STATE`, `INSTITUTION_SUBTYPE_COMPONENT`, `INSTITUTION_SUBTYPE_FEDERAL`, `INSTITUTION_SUBTYPE_SPED`, `INSTITUTION_SUBTYPE_VOCATIONAL`, `INSTITUTION_SUBTYPE_ALTERNATIVE`, `INSTITUTION_SUBTYPE_SELPA` - `access` (enum, optional) — InstitutionAccess is who may attend. - Allowed values: `INSTITUTION_ACCESS_UNSPECIFIED`, `INSTITUTION_ACCESS_CONSORTIUM`, `INSTITUTION_ACCESS_PRIVATE`, `INSTITUTION_ACCESS_PUBLIC` - `model` (string, optional) — A further classification NCES or the source gives, such as CHARTER or MAGNET; free text. - `religious_affiliation` (string, optional) — The religious affiliation of a private school, as reported; free text. - `nces_id` (string, optional) — The NCES id: a school's 12 digits or a district's 7. - `nces_school_id` (string, optional) — The NCES school id; schools only. - `nces_district_id` (string, optional) — The NCES district id; districts and agencies only. - `address` (string, optional) — The physical address, as one line. - `city` (string, optional) - `state` (string, optional) — The state's postal code, such as TX. - `zip` (string, optional) - `county_id` (string, optional) — The county's FIPS code. - `county_name` (string, optional) - `latitude` (double, optional) - `longitude` (double, optional) - `phone` (string, optional) - `fax` (string, optional) - `website_url` (string, optional) - `student_count` (string, optional) - `staff_count` (string, optional) - `classroom_teacher_count` (double, optional) — Classroom teachers in full-time equivalents, so it may be fractional. - `student_teacher_ratio` (double, optional) - `revenue_usd` (string, optional) — Annual revenue in whole US dollars. - `tuition_usd` (string, optional) — Annual tuition in whole US dollars; private schools. - `title_one` (boolean, optional) — Whether the school or district receives Title I funding. - `charter` (boolean, optional, nullable) — Whether NCES lists it as a charter; unset when NCES does not say. - `charter_lea` (string, optional) — The NCES charter LEA status code, such as NOTCHR or CHRTESA. - `grades` (list of string, optional) — The grades it serves, lowest first: PK, KG, 1 to 13, UG (ungraded), AE (adult education). - `child_count` (string, optional) — How many schools a district or agency runs. - `parent` (edulead.v4.InstitutionParent, optional) — The district or organization it belongs to; unset for a top-level institution. - `email_domains` (list of edulead.v4.InstitutionEmailDomain, optional) — The email domains of the institution's staff, the largest first, with the address formats seen on each. Set by GetInstitution only. - `fulltext_matches` (list of edulead.v4.InstitutionTextMatch, optional) — The pages of the institution's websites that matched a fulltext condition, at most 20. Set by SearchInstitutions only, when it has one. - `create_time` (datetime, optional) — When Edulead created the resource. - `update_time` (datetime, optional) — When any field last changed. ### edulead.v4.InstitutionParent InstitutionParent is the district or organization an institution belongs to. - `id` (string, optional) — Identifier of the resource, assigned by Edulead and opaque to callers. - `name` (string, optional) - `type` (enum, optional) — InstitutionType is what kind of institution it is. - Allowed values: `INSTITUTION_TYPE_UNSPECIFIED`, `INSTITUTION_TYPE_DISTRICT`, `INSTITUTION_TYPE_SCHOOL`, `INSTITUTION_TYPE_AGENCY`, `INSTITUTION_TYPE_UNION`, `INSTITUTION_TYPE_PARENT_ORG`, `INSTITUTION_TYPE_SELPA` - `nces_district_id` (string, optional) — The parent's NCES district id. ### edulead.v4.InstitutionEmailDomain InstitutionEmailDomain is one email domain of an institution's staff. - `domain` (string, optional) - `domain_total` (integer, optional) — How many of the institution's contacts have an address on this domain. - `formats` (list of edulead.v4.InstitutionEmailFormat, optional) — The address formats seen on this domain, the most common first, at most 5. ### edulead.v4.InstitutionTextMatch InstitutionTextMatch is a page of an institution's website that matched a fulltext condition. - `url` (string, optional) - `snippet` (string, optional) — The matching passage as HTML, with each match inside \ tags. ### edulead.v4.InstitutionEmailFormat InstitutionEmailFormat is one way the addresses on a domain are built. - `email_format` (string, optional) — The format, such as first.last or flast. - `contact_count` (integer, optional) — How many contacts' addresses follow it. - `percentage` (double, optional) — Its share of the domain's addresses, in percent. - `rank` (integer, optional) — Its rank on the domain, 1 for the most common. ## Examples **Response** ```json { "institution": { "id": "string", "name": "string", "type": "INSTITUTION_TYPE_UNSPECIFIED", "subtype": "INSTITUTION_SUBTYPE_UNSPECIFIED", "access": "INSTITUTION_ACCESS_UNSPECIFIED", "model": "string", "religious_affiliation": "string", "nces_id": "string", "nces_school_id": "string", "nces_district_id": "string", "address": "string", "city": "string", "state": "string", "zip": "string", "county_id": "string", "county_name": "string", "latitude": 1.1, "longitude": 1.1, "phone": "string", "fax": "string", "website_url": "string", "student_count": "string", "staff_count": "string", "classroom_teacher_count": 1.1, "student_teacher_ratio": 1.1, "revenue_usd": "string", "tuition_usd": "string", "title_one": true, "charter": true, "charter_lea": "string", "grades": [ "string" ], "child_count": "string", "parent": { "id": "string", "name": "string", "type": "INSTITUTION_TYPE_UNSPECIFIED", "nces_district_id": "string" }, "email_domains": [ { "domain": "string", "domain_total": 1, "formats": [ { "email_format": "string", "contact_count": 1, "percentage": 1.1, "rank": 1 } ] } ], "fulltext_matches": [ { "url": "string", "snippet": "string" } ], "create_time": "2023-01-15T01:30:15.01Z", "update_time": "2023-01-15T01:30:15.01Z" } } ``` **SDK Code** ```python import requests url = "https://api.getedulead.com/v4/institutions/id" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.getedulead.com/v4/institutions/id'; const options = {method: 'GET', headers: {Authorization: 'Bearer '}}; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.getedulead.com/v4/institutions/id" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.getedulead.com/v4/institutions/id") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.getedulead.com/v4/institutions/id") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.getedulead.com/v4/institutions/id', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.getedulead.com/v4/institutions/id"); var request = new RestRequest(Method.GET); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = ["Authorization": "Bearer "] let request = NSMutableURLRequest(url: NSURL(string: "https://api.getedulead.com/v4/institutions/id")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```