Skip to navigation
API ReferenceExports

ListExportReviewRecords

ListExportReviewRecords pages through the records an export’s review recommended a decision for, oldest first, each with the records that hang off it (a contact’s institution links).

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

export_idstringRequiredformat: "uuid"1-36 characters
The export whose records to list.

Headers

Edulead-TeamstringRequired

Query parameters

filter.decisionenumOptional

Only records with this decision, and only such children; TAKE also lists a skipped record with a taken child. UNSPECIFIED means any. enum.defined_only = true

Allowed values:
filter.email_statusstringOptional<=50 characters
Only records with this email verification result.
filter.export_statusenumOptional

Only records with this export status; UNSPECIFIED means any. enum.defined_only = true

Allowed values:
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.

Allowed values:

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.