GetMatch | Edulead API

{
  "match": {
    "id": "string",
    "state": "MATCH_STATE_UNSPECIFIED",
    "strategy": "MATCH_STRATEGY_UNSPECIFIED",
    "hubspot_name_property": "string",
    "hubspot_address_property": "string",
    "hubspot_state_property": "string",
    "hubspot_nces_id_property": "string",
    "creator_id": "string",
    "companies_fetched": 1,
    "companies_total": 1,
    "companies_matched": 1,
    "matched_by_nces": 1,
    "matched_by_name": 1,
    "institutions_distinct": 1,
    "failure_message": "string",
    "hubspot_portal_id": "string",
    "stats": {
      "total": 1,
      "matched": 1,
      "unmatched": 1,
      "included": 1,
      "distinct_institutions": 1,
      "by_tier": [
        {
          "tier": "MATCH_TIER_UNSPECIFIED",
          "count": 1
        }
      ],
      "by_failure_reason": [
        {
          "reason": "MATCH_FAILURE_REASON_UNSPECIFIED",
          "count": 1
        }
      ]
    },
    "create_time": "2023-01-15T01:30:15.01Z",
    "complete_time": "2023-01-15T01:30:15.01Z",
    "update_time": "2023-01-15T01:30:15.01Z"
  }
}

GetMatch returns one of the team's matches with its live stats and the team's HubSpot portal id.

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

matchobjectOptional

Match is one matching of the team’s HubSpot companies to Edulead institutions. On create, strategy and the hubspot_*_property fields are read; the service sets the others.

Authentication

Path parameters

Headers

Response