Skip to navigation
API ReferenceInstitutions

ListUnlockedInstitutions

ListUnlockedInstitutions pages through the institutions the team has unlocked, each the first time an export included it, newest first, 100 a page by default.

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>.

Headers

Edulead-TeamstringRequired

Query parameters

order_byenumOptional

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

Allowed values:
page_sizeintegerOptional0-100
Number of items per page, at most the maximum shown. Omitted or 0 means the RPC's default page size.
page_tokenstringOptional<=1024 characters

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

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.

total_sizestringOptionalformat: "int64"
How many institutions the team has unlocked.