Create a project view
Project views are saved filter-and-layout combinations for a project. Create a project view.
Path parameters
slug:requiredstringThe workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.
project_id:requiredstringThe project the resource belongs to. Accepts the project UUID or its bare identifier, for example ENG.
Body parameters
name:requiredstringThe view's display name.
Maximum 255 characters.
access:optionalstringWho can see the view: 0 for private, 1 for public.
description:optionalstringFree-form description.
display_filters:optionalstringSaved display options: grouping, ordering and layout.
display_properties:optionalstringDisplay properties saved with the view.
filters:optionalstringSaved filter set, in the same shape the list endpoints accept.
is_locked:optionalbooleanPrevents further edits to the content.
logo_props:optionalstringLogo descriptor managed by the Plane editor. Send back the value you read instead of building it by hand.
pql_filters:optionalstringSaved filters, written in PQL.
sort_order:optionalnumberManual ordering weight. Lower sorts first.
Response shaping
fields:optionalstringComma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null. id is always included. Pass all to get every requestable field. An unknown field name returns 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, updated_at, updated_by_id.
expand:optionalstringComma-separated relations to embed: owned_by.
Expanded objects get their own key: ?expand=state keeps state_id and adds a state object next to it. ?fields= and ?expand= work independently. Naming a relation in ?fields= returns 400, and field filtering never removes an expanded object. See Expanding relations.
Scopes
projects.views:write
Errors
| Status | Code | Cause |
|---|---|---|
400 | invalid_request | The request body or a query parameter failed validation. |
401 | unauthorized | Missing or invalid credentials. |
402 | payment_required | The feature this endpoint belongs to isn't enabled on your plan or is switched off. |
403 | forbidden | Your role or token scope doesn't allow this. |
404 | not_found | No such resource, or it's outside your tenant. |
406 | not_acceptable | The Accept header asks for a representation the API can't produce. |
409 | conflict | A business rule blocks the write. |
413 | payload_too_large | The request body is over the size limit. |
415 | unsupported_media_type | The Content-Type isn't one this endpoint accepts. |
429 | rate_limited | Throttled. Honor the Retry-After header before retrying. |
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
}'import requests
response = requests.post(
"https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/views/",
headers={"X-Api-Key": "your-api-key"},
json={
"name": "Example name",
"access": None,
"description": "What this is for.",
"display_filters": None
},
)
print(response.json())const response = await fetch(
"https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/views/",
{
method: "POST",
headers: {
"X-Api-Key": "your-api-key",
"Content-Type": "application/json",
},
body: JSON.stringify({
name: "Example name",
access: null,
description: "What this is for.",
display_filters: null,
}),
},
);
const data = await response.json();{
"access": 0,
"archived_at": null,
"created_at": "2026-01-14T09:22:41.478363Z",
"updated_at": "2026-01-14T09:22:41.478363Z",
"created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
"updated_by_id": null,
"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
}
