Skip to navigation
API ReferenceMatches

ListMatchRows

ListMatchRows pages through a match’s rows, one per HubSpot company, oldest first unless order_by says otherwise.

Authentication

AuthorizationBearer

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

OR
AuthorizationBearer

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

Path parameters

match_idstringRequiredformat: "uuid"1-36 characters
The match whose rows to list.

Headers

Edulead-TeamstringRequired

Query parameters

filter.outcomeenumOptional

Only rows with this outcome; UNSPECIFIED means any. enum.defined_only = true

Allowed values:
filter.includedbooleanOptional

Only included (true) or excluded (false) rows; unset means both.

filter.match_confidence_mindoubleOptional0-1
Only rows whose confidence is at least this.
filter.match_confidence_maxdoubleOptional0-1
Only rows whose confidence is at most this.
filter.tier_inlist of enumsOptional
Only rows matched by any of these tiers.
Allowed values:
filter.failure_reason_inlist of enumsOptional
Only rows unmatched for any of these reasons.
page_sizeintegerOptional0-500
Number of items per page, at most the maximum shown. Omitted or 0 means the RPC's default page size.
page_tokenstringOptional<=512 characters

Opaque token from a previous response; empty for the first page.

order_byenumOptional

Sort order: a sortable field name, optionally followed by ” desc”. The allowed values are listed.

Response

Success
itemslist of objectsOptional
The page of results, in the requested order.
next_page_tokenstringOptional

Token for the next page; empty when this is the last page.