CRcraft
Views

GET /workspace/{workspaceId}/views/{viewId}

Changed on

A single view's full configuration, by its id.

Request

  • Base URL
    https://api.craft.io
  • URL
    https://api.craft.io/workspace/{workspaceId}/views/{viewId}
  • Auth
    API key in header x-api-key

Path parameters

workspaceIdstring required
viewIdstring required

Query parameters

includeRawboolean

Also return the stored state verbatim.

includeCompletedboolean

Include released items in listItemsParams. A view with no status filter hides them, so they are excluded by default to match what the view shows.

Response

The view configuration

viewIdstring required
namestring required
viewTypestring required
ownerType'personal' | 'workspace' required
categorystring
workspaceIdstring
portfolioIdstring
webUrlstring
columnsstring[]
layoutstring[]
compactModestring

Card density on a card-based view: compact or default.

filtersRecordStringUnknown required

Construct a type with a set of properties K of type T

listItemsParamsRecordStringString 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.

columnColorsRecordStringString

Construct a type with a set of properties K of type T

Changes

  • 2972a1b05ab1Revision changes
    • info

      added the optional property to the response with the status

  • 10d02d3ad149Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status