ConnectCloud Developers

List saved views (tenant:forge:read)

GET /api/forge/v1/views

Module: Forge · operationId: listForgeViews · Tag: Views · Auth: access token (Authorization: Bearer <accessToken>)

Requires tenant:forge:read. With project (a key the caller sees, else 404) the views of that project, i.e. its project views and the caller's personal views in it; without, the caller's personal tenant-wide items views. Other people's personal views are never listed.

Parameters

Name In Type Required Description
project query string Project key

Responses

  • 200 The views in their order (application/json)
  • 404 Error (application/json)

Fields of the 200 answer:

  • items (array of View, required)
    • columns (array of string, required): Columns of the list
    • createdAt (string (date-time), required): When the view was created
    • groupBy (string, nullable, required): status, assignee, milestone, iteration or label-scope:
    • id (string (uuid), required): View id
    • kind (string, required): list or board (one of list, board)
    • name (string, required): Name (max length 80)
    • ownerRef (string, required): E-mail address of the creator
    • position (integer, required): Order of the views
    • projectId (string (uuid), nullable, required): null: a tenant-wide items view (always personal)
    • projectKey (string, nullable, required): Key of the project; null for a tenant-wide view
    • query (object, required): Item search filters, as the query parameters of GET /items (strings)
      • assignee (string): Assignee e-mails, comma separated
      • category (string): Status categories, comma separated
      • iteration (string): Iteration ids, comma separated
      • label (string): Label names, comma separated
      • milestone (string): Milestone ids, comma separated
      • open (string): Only open (true) or only closed (false) items (one of true, false)
      • q (string): Full-text search or an item reference
      • status (string): Status keys, comma separated
      • type (string): Item type keys, comma separated
    • scope (string, required): personal: the owner's own; project: part of the project's configuration (one of personal, project)
    • sort (string, required): Empty: the default of the list the view runs in (one of ``, updated, created, rank, number)
    • version (integer, required): Optimistic-locking version; send it with PATCH

Example 200 answer:

{
  "items": [
    {
      "columns": [],
      "createdAt": "2026-10-28T11:25:00Z",
      "groupBy": "status",
      "id": "2d3e4f5a-6b7c-4d8e-9fa0-1b2c3d4e5f02",
      "kind": "list",
      "name": "Nach Status",
      "ownerRef": "emma.maier@muster-it.example",
      "position": 0,
      "projectId": "0b6c1e1e-3f0b-4e8e-9f3f-1d2c3b4a5f60",
      "projectKey": "APP",
      "query": {
        "open": "true"
      },
      "scope": "project",
      "sort": "",
      "version": 1
    },
    {
      "columns": [],
      "createdAt": "2026-10-28T11:30:00Z",
      "groupBy": "status",
      "id": "2d3e4f5a-6b7c-4d8e-9fa0-1b2c3d4e5f01",
      "kind": "board",
      "name": "Aktuelle Iteration",
      "ownerRef": "emma.maier@muster-it.example",
      "position": 1,
      "projectId": "0b6c1e1e-3f0b-4e8e-9f3f-1d2c3b4a5f60",
      "projectKey": "APP",
      "query": {
        "iteration": "active"
      },
      "scope": "project",
      "sort": "rank",
      "version": 1
    }
  ]
}

Example request

curl -X GET 'https://api.mbcom.cloud/api/forge/v1/views' \
  -H "Authorization: Bearer $ACCESS_TOKEN"

View as Markdown · Interactive reference · OpenAPI