GetInstitution | Edulead API

{
  "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"
  }
}

GetInstitution returns one institution of the catalogue by id, with the email domains its staff use and the address formats seen on each.

Authentication

AuthorizationBearer

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

AuthorizationBearer

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

Path parameters

idstringRequiredformat: "uuid"1-36 characters

Identifier of the resource, assigned by Edulead and opaque to callers.

Response

Success

institutionobjectOptional

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.

Authentication

Path parameters

Headers

Response