---
title: "GET /workspace/{workspaceId}/view"
method: GET
path: "/workspace/{workspaceId}/view"
tags: ["Views"]
---

# GET /workspace/{workspaceId}/view

`GET /workspace/{workspaceId}/view`

Resolve a view by name. Returns the view, or every candidate when the name
is not unique in the container.

## Path parameters

- `workspaceId` string, required

## Query parameters

- `name` string, required
- `ownerType` 'personal' | 'workspace'
- `category` string
- `includeRaw` boolean
- `includeCompleted` boolean

## Response `200`

The view, or the candidates to choose between

- ViewLookupResponse — A name lookup resolves to one view, or reports every candidate so the caller can narrow by ownerType / category. Two views may share a name — the id is the identity, the name is a convenience.
  - `view` ViewDetail
    - `viewId` string, required
    - `name` string, required
    - `viewType` string, required
    - `ownerType` 'personal' | 'workspace', required
    - `category` string
    - `workspaceId` string
    - `portfolioId` string
    - `webUrl` string
    - `controllers` ViewControllers, required
      - `sortBy` string
      - `sortDirection` 'asc' | 'desc'
      - `groupBy` string
      - `swimLanesBy` string
    - `columns` string[]
    - `layout` string[]
    - `compactMode` string — Card density on a card-based view: `compact` or `default`.
    - `filters` RecordStringUnknown, required — Construct a type with a set of properties K of type T
    - `listItemsParams` RecordStringString, required — Construct a type with a set of properties K of type T
    - `listItemsTool` 'list_items' | 'list_portfolio_items' | 'list_feedback_items', required — Which list tool `listItemsParams` belongs to. Feedback views are the reason this is stated rather than assumed — their items are not work items.
    - `unsupportedFilters` UnsupportedFilter[] — Filters the list endpoints cannot reproduce — the result will be wider.
      - `filter` string, required
      - `reason` string, required
    - `raw` WireView — A view exactly as the views service stores it. Unknown props round-trip.
      - `id` string
      - `name` string
      - `categoryId` string
      - `workspaceId` string
      - `personId` string, nullable
      - `ownerType` string
      - `viewType` string
      - `orderIndex` string
      - `category` string, nullable
      - `nameId` string, nullable
      - `description` string, nullable
      - `viewFields` string[], nullable
      - `compactViewFields` string[], nullable
      - `compactMode` string, nullable — Card density on a card-based view; empty string means never set.
      - `groupBy` string, nullable
      - `groupByCustomFieldId` string, nullable
      - `secondaryGroupBy` string, nullable
      - `secondaryGroupByCustomFieldId` string, nullable
      - `sortBy` string, nullable
      - `sortByCustomFieldId` string, nullable
      - `reverse` boolean, nullable
      - `isChanged` boolean
      - `okrHierarchy` string, nullable
      - `fieldFilters` RecordStringUnknown — Construct a type with a set of properties K of type T
      - `filters` RecordStringUnknown — Construct a type with a set of properties K of type T
  - `candidates` ViewSummary[]
    - `viewId` string, required
    - `name` string, required
    - `viewType` string, required
    - `ownerType` 'personal' | 'workspace', required
    - `category` string
    - `workspaceId` string
    - `portfolioId` string
    - `webUrl` string

## Other responses

- `404` — No view with that name

---

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