CRcraft
Views

GET /workspace/{workspaceId}/view

Changed on

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

Request

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

Path parameters

workspaceIdstring required

Query parameters

namestring required

Exact view name (case-insensitive).

ownerType'personal' | 'workspace'

Narrow to personal or workspace.

categorystring

Narrow to a category name.

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, or the candidates to choose between

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