> 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. # ListMatchRows GET https://api.getedulead.com/v4/matches/{match_id}/rows ListMatchRows pages through a match's rows, one per HubSpot company, oldest first unless order_by says otherwise. Reference: https://docs.getedulead.com/api-reference/matches/list-rows ## 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 - `match_id` (string, required) — The match whose rows to list. ### Query parameters - `filter.outcome` (enum, optional) — Only rows with this outcome; UNSPECIFIED means any. enum.defined_only = true - Allowed values: `MATCH_OUTCOME_UNSPECIFIED`, `MATCH_OUTCOME_PENDING`, `MATCH_OUTCOME_MATCHED`, `MATCH_OUTCOME_NO_MATCH` - `filter.included` (boolean, optional) — Only included (true) or excluded (false) rows; unset means both. - `filter.match_confidence_min` (double, optional) — Only rows whose confidence is at least this. - `filter.match_confidence_max` (double, optional) — Only rows whose confidence is at most this. - `filter.tier_in` (list of enum, optional) — Only rows matched by any of these tiers. - Allowed values: `MATCH_TIER_UNSPECIFIED`, `MATCH_TIER_NCES_ID`, `MATCH_TIER_NCES_ALT`, `MATCH_TIER_NAME_ADDRESS` - `filter.failure_reason_in` (list of enum, optional) — Only rows unmatched for any of these reasons. - Allowed values: `MATCH_FAILURE_REASON_UNSPECIFIED`, `MATCH_FAILURE_REASON_NO_CANDIDATE`, `MATCH_FAILURE_REASON_BELOW_THRESHOLD`, `MATCH_FAILURE_REASON_MULTIPLE`, `MATCH_FAILURE_REASON_NO_NAME`, `MATCH_FAILURE_REASON_NO_STATE` - `page_size` (integer, optional) — Number of items per page, at most the maximum shown. Omitted or 0 means the RPC's default page size. - `page_token` (string, optional) — Opaque token from a previous response; empty for the first page. - `order_by` (enum, optional) — Sort order: a sortable field name, optionally followed by " desc". The allowed values are listed. - Allowed values: ``, `create_time`, `match_confidence desc`, `match_confidence`, `company_name`, `company_name desc` ## Response ### 200 Success - `items` (list of edulead.v4.MatchRow, optional) — The page of results, in the requested order. - `next_page_token` (string, optional) — Token for the next page; empty when this is the last page. ## Types ### edulead.v4.MatchRow MatchRow is one HubSpot company of a match and what it matched. Only included can change. - `id` (string, optional) — Identifier of the resource, assigned by Edulead and opaque to callers. - `match_id` (string, optional) — The match it belongs to. - `hubspot_company_id` (string, optional) - `company_name` (string, optional) - `company_address` (string, optional) - `company_state` (string, optional) — Two-letter code, or empty. - `company_nces_id` (string, optional) - `outcome` (enum, optional) — enum.defined_only = true - Allowed values: `MATCH_OUTCOME_UNSPECIFIED`, `MATCH_OUTCOME_PENDING`, `MATCH_OUTCOME_MATCHED`, `MATCH_OUTCOME_NO_MATCH` - `tier` (enum, optional) — Set when MATCHED. enum.defined_only = true - Allowed values: `MATCH_TIER_UNSPECIFIED`, `MATCH_TIER_NCES_ID`, `MATCH_TIER_NCES_ALT`, `MATCH_TIER_NAME_ADDRESS` - `subtype` (enum, optional) — Set for a name match. enum.defined_only = true - Allowed values: `MATCH_SUBTYPE_UNSPECIFIED`, `MATCH_SUBTYPE_EXACT`, `MATCH_SUBTYPE_LEVENSHTEIN` - `match_confidence` (double, optional, nullable) — 0 to 1. - `institution_id` (string, optional) — The matched institution. - `institution_name` (string, optional) - `institution_type` (string, optional) - `institution_address` (string, optional) - `institution_nces_id` (string, optional) - `institution_nces_district_id` (string, optional) - `best_candidate_name` (string, optional) — The closest institution that was not matched, and its score (0 to 1). - `best_candidate_score` (double, optional, nullable) - `failure_reason` (enum, optional) — Set when NO_MATCH. enum.defined_only = true - Allowed values: `MATCH_FAILURE_REASON_UNSPECIFIED`, `MATCH_FAILURE_REASON_NO_CANDIDATE`, `MATCH_FAILURE_REASON_BELOW_THRESHOLD`, `MATCH_FAILURE_REASON_MULTIPLE`, `MATCH_FAILURE_REASON_NO_NAME`, `MATCH_FAILURE_REASON_NO_STATE` - `included` (boolean, optional) — Whether an export of the match takes the row. - `create_time` (datetime, optional) — When Edulead created the resource. ## Examples **Response** ```json { "items": [ { "id": "string", "match_id": "string", "hubspot_company_id": "string", "company_name": "string", "company_address": "string", "company_state": "string", "company_nces_id": "string", "outcome": "MATCH_OUTCOME_UNSPECIFIED", "tier": "MATCH_TIER_UNSPECIFIED", "subtype": "MATCH_SUBTYPE_UNSPECIFIED", "match_confidence": 1.1, "institution_id": "string", "institution_name": "string", "institution_type": "string", "institution_address": "string", "institution_nces_id": "string", "institution_nces_district_id": "string", "best_candidate_name": "string", "best_candidate_score": 1.1, "failure_reason": "MATCH_FAILURE_REASON_UNSPECIFIED", "included": true, "create_time": "2023-01-15T01:30:15.01Z" } ], "next_page_token": "string" } ``` **SDK Code** ```python import requests url = "https://api.getedulead.com/v4/matches/match_id/rows" headers = {"Authorization": "Bearer "} response = requests.get(url, headers=headers) print(response.json()) ``` ```javascript const url = 'https://api.getedulead.com/v4/matches/match_id/rows'; 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/matches/match_id/rows" 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/matches/match_id/rows") 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/matches/match_id/rows") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.getedulead.com/v4/matches/match_id/rows', [ 'headers' => [ 'Authorization' => 'Bearer ', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.getedulead.com/v4/matches/match_id/rows"); 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/matches/match_id/rows")! 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() ```