Skip to main content
POST
Get available institutions

Authorizations

x-access-token
string
header
required

JWT token passed in x-access-token header

Body

application/json

Optional search term to filter institutions by name, ainame, or account name (case-insensitive)

Example:

"Biology"

page
integer

Optional 1-based page number. Its presence (or pageSize's) switches the response to paged mode. Non-numeric or < 1 is treated as 1.

Required range: x >= 1
Example:

2

pageSize
integer
default:25

Optional rows per page, clamped to 1..100. Non-numeric falls back to 25. Its presence (or page's) switches the response to paged mode.

Required range: 1 <= x <= 100
Example:

25

Response

Available institutions retrieved successfully

success
boolean
Example:

true

entitlements
object[]
totalAvailable
integer

Total number of available institutions before search filtering

Example:

42

page
integer

Paged mode only — the 1-based page that was served (after coercion).

Example:

2

pageSize
integer

Paged mode only — the effective rows-per-page (after clamping/defaulting).

Example:

25

totalMatching
integer

Paged mode only — number of rows matching the search filter across all pages (totalAvailable stays pre-search).

Example:

31

hasMore
boolean

Paged mode only — true when page * pageSize < totalMatching, i.e. a further page exists.

Example:

true