---
title: "Create New Workspace"
method: POST
path: "/api/v3/workspaces/create"
tags: ["Workspaces"]
---

# Create New Workspace

`POST /api/v3/workspaces/create`

Create a new workspace and add filtered institutions to it.

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

- WorkspaceResponse
  - `data` Workspace, required
    - `id` string, uuid
    - `created_at` string, date-time
    - `is_starred` boolean
    - `modified_at` string, date-time, nullable, required
    - `name` string, nullable, required
    - `user_id` string, required
    - `payload` object, nullable
    - `ui_metadata` object, nullable
    - `is_deleted` boolean
    - `deleted_at` string, date-time, nullable
    - `list_id` string, uuid, nullable

## 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/versions/85804e68d86d/schema)