Skip to content

Project views overview ​

Project views are saved filter-and-layout combinations for a project.

The project view object ​

Attributes ​

  • access integer

    Who can see this.

  • archived_at string (date-time)

    When the record was archived, or null if it is active.

  • created_at string (date-time)

    When the record was created.

  • created_by_id string (uuid)

    The user who created the record.

  • description string

    Free-form description.

  • display_filters string

    Saved display options — grouping, ordering and layout.

  • display_properties string

    The display properties.

  • filters string

    Saved filter set, in the same shape the list endpoints accept.

  • id string (uuid)

    Unique identifier.

  • is_locked boolean

    Prevents further edits to the content.

  • logo_props string

    Editor-owned logo descriptor. Pass back what you read rather than composing it by hand.

  • name string

    Display name.

  • owned_by_id string (uuid)

    The related owned by.

  • pql_filters string

    The pql filters.

  • query string

    The query.

  • sort_order number

    Manual ordering weight. Lower sorts first.

Response200
json
{
  "access": 0,
  "archived_at": null,
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description": "What this is for.",
  "display_filters": null,
  "display_properties": null,
  "filters": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_locked": false,
  "logo_props": null,
  "name": "Example name",
  "owned_by_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "pql_filters": null,
  "query": null,
  "sort_order": 65535
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/projects/{project_id}/views/List project views
GET/api/v2/workspaces/{slug}/projects/{project_id}/views/{pk}/Get a project view
POST/api/v2/workspaces/{slug}/projects/{project_id}/views/Create a project view
PATCH/api/v2/workspaces/{slug}/projects/{project_id}/views/{pk}/Update a project view
DELETE/api/v2/workspaces/{slug}/projects/{project_id}/views/{pk}/Delete a project view

Response shaping ​

Every project view read accepts ?fields= for sparse responses — see Sparse fields. Errors follow the shared problem+json contract.