GetPerson | Edulead API

{
  "person": {
    "id": "string",
    "name": "string",
    "first_name": "string",
    "middle_name": "string",
    "last_name": "string",
    "title": "string",
    "title_rank": 1,
    "email": "string",
    "email_domain": "string",
    "email_type": "string",
    "email_format": "string",
    "email_source": "string",
    "email_verification_status": "string",
    "email_verify_time": "2023-01-15T01:30:15.01Z",
    "phone": "string",
    "phone_uniqueness": "string",
    "state": "string",
    "account_id": "string",
    "account_priority": 1.1,
    "account_student_count": "string",
    "priority": 1,
    "labels": [
      "string"
    ],
    "bios": [
      {
        "text": "string",
        "create_time": "2023-01-15T01:30:15.01Z"
      }
    ],
    "institutions": [
      {
        "institution_id": "string",
        "name": "string",
        "type": "string",
        "subtype": "string",
        "access": "string",
        "state": "string",
        "zip": "string",
        "county_id": "string",
        "student_count": "string",
        "staff_count": "string",
        "revenue_usd": "string",
        "nces_id": "string",
        "nces_district_id": "string",
        "address": "string",
        "city": "string"
      }
    ],
    "roles": [
      {
        "code": "string",
        "role": "string",
        "area": "string",
        "modifier": "string",
        "status": "string",
        "level": "string",
        "system_status": "string",
        "confidence": 1.1,
        "rank": 1,
        "decision_level": "string",
        "functional_group": "string",
        "market_themes": [
          "string"
        ],
        "evidence_count": 1,
        "first_observe_time": "2023-01-15T01:30:15.01Z",
        "last_observe_time": "2023-01-15T01:30:15.01Z",
        "evidence": [
          {
            "id": "string",
            "normalized_title": "string",
            "source_type": "string",
            "match_method": "string",
            "status": "string",
            "first_name": "string",
            "middle_name": "string",
            "last_name": "string",
            "observe_time": "2023-01-15T01:30:15.01Z",
            "observations": [
              {
                "institution_id": "string",
                "resolution_method": "string",
                "resolution_value": "string"
              }
            ],
            "url": {
              "url_id": "string",
              "url": "string",
              "url_type": "string",
              "url_status": "string",
              "screenshot_key": "string"
            }
          }
        ]
      }
    ],
    "first_observe_time": "2023-01-15T01:30:15.01Z",
    "last_observe_time": "2023-01-15T01:30:15.01Z",
    "fulltext_matches": [
      {
        "url": "string",
        "snippet": "string"
      }
    ],
    "update_time": "2023-01-15T01:30:15.01Z"
  }
}

GetPerson returns one person by id. Opening a person counts nothing toward the limits.

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

personobjectOptional

Person is a person Edulead knows at one or more institutions. The values are the Edulead keystone’s; zero values are omitted.

Authentication

Path parameters

Headers

Response