Skip to content

Create a project view ​

POST/api/v2/workspaces/{slug}/projects/{project_id}/views/

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

Path Parameters ​

slug:requiredstring

The workspace slug. It appears in your Plane URLs — in https://app.plane.so/my-team/projects/, the slug is my-team.

project_id:requiredstring

The project the resource belongs to. Accepts the project UUID or its bare identifier, for example ENG.

Body Parameters ​

name:requiredstring

Display name.

Maximum 255 characters.

access:optionalstring

Who can see this.

description:optionalstring

Free-form description.

display_filters:optionalstring

Saved display options — grouping, ordering and layout.

display_properties:optionalstring

The display properties.

filters:optionalstring

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

is_locked:optionalboolean

Prevents further edits to the content.

logo_props:optionalstring

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

pql_filters:optionalstring

The pql filters.

sort_order:optionalnumber

Manual ordering weight. Lower sorts first.

Response shaping ​

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: access, archived_at, created_at, created_by_id, description, display_filters, display_properties, filters, id, is_locked, logo_props, name, owned_by_id, pql_filters, query, sort_order.

expand:optionalstring

Comma-separated relations to embed: owned_by.

Expansion is separate-key — ?expand=state keeps state_id and adds a state object next to it. ?fields= and ?expand= are independent: naming a relation in ?fields= is a 400, and expanded objects survive field filtering. See Expanding relations.

Scopes ​

projects.views:write

Errors ​

StatusCodeCause
400invalid_requestThe request body or a query parameter failed validation.
401unauthorizedMissing or invalid credentials.
402payment_requiredThe feature this endpoint belongs to isn't enabled on your plan or is switched off.
403forbiddenYour role or token scope doesn't allow this.
404not_foundNo such resource, or it's outside your tenant.
406not_acceptableThe Accept header asks for a representation the API can't produce.
409conflictA business rule blocks the write — see the notes above.
413payload_too_largeThe request body is over the size limit.
415unsupported_media_typeThe Content-Type isn't one this endpoint accepts.
429rate_limitedThrottled. Honor the Retry-After header before retrying.
Create a project view
bash
curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/views/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example name",
  "access": null,
  "description": "What this is for.",
  "display_filters": null
}'
Response201
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
}