Sign in

v1

latestOpenAPI 3.1.02026-08-04253331435.1 KB
Workspaces

Preview Institutions

Preview filtered institutions for a workspace with pagination.

post/api/v3/workspaces/preview

Request body

codesstring[] nullable
unique_idsstring[] nullable
namestring nullable
institution_typesstring[] nullable
included_statesstring[] nullable
excluded_statesstring[] nullable
included_countiesstring[] nullable
excluded_countiesstring[] nullable
included_citiesstring[] nullable
excluded_citiesstring[] nullable
min_populationnumber nullable
max_populationnumber nullable
keywordsstring[] nullable
search_querystring nullable
result_limitinteger nullable
pageinteger
list_idstring uuid nullable
workspace_setup_choicestring nullable

Response

Successful Response

countinteger required
pageinteger required
page_sizeinteger required
total_pagesinteger required
should_paginateboolean required