---
title: "Preview Institutions"
method: POST
path: "/api/v3/workspaces/preview"
tags: ["Workspaces"]
---

# Preview Institutions

`POST /api/v3/workspaces/preview`

Preview filtered institutions for a workspace with pagination.

## Request body

- WorkspacePreviewRequest
  - `codes` string[], nullable
  - `unique_ids` string[], nullable
  - `name` string, nullable
  - `institution_types` string[], nullable
  - `included_states` string[], nullable
  - `excluded_states` string[], nullable
  - `included_counties` string[], nullable
  - `excluded_counties` string[], nullable
  - `included_cities` string[], nullable
  - `excluded_cities` string[], nullable
  - `min_population` number, nullable
  - `max_population` number, nullable
  - `keywords` string[], nullable
  - `search_query` string, nullable
  - `result_limit` integer, nullable
  - `ui_metadata` UiMetadataColumns
    - `columns` object, required
    - `column_order` string[], required
    - `pinned_columns` string[], nullable
  - `page` integer
  - `list_id` string, uuid, nullable
  - `workspace_setup_choice` string, nullable

## Response `200`

Successful Response

- PreviewInstitutionsResponse
  - `data` Institution[], required
    - `unique_id` string, required
    - `source_id` integer, nullable, required
    - `name` string, nullable, required
    - `state` string, nullable, required
    - `county` string, nullable, required
    - `city` string, nullable, required
    - `street` string, nullable, required
    - `state_county` string, nullable, required
    - `state_city` string, nullable, required
    - `population` number, nullable, required
    - `source_table` 'k12_districts' | 'cities' | 'counties' | 'higher_education' | 'federal_agencies' | 'federal_departments' | 'individual_units' | 'k12_schools' | 'police_agencies' | 'usfa_registry' | 'state_agencies' | 'states'
    - `label` string, nullable, required
    - `is_active` boolean, nullable
  - `count` integer, required
  - `page` integer, required
  - `page_size` integer, required
  - `total_pages` integer, required
  - `should_paginate` boolean, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/nationgraph/apis/nationgraph-api.md) · [All operations](https://skmtc.net/nationgraph/apis/nationgraph-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nationgraph/nationgraph-api/revisions/85804e68d86d/schema)