Plane DocsSign in

Projects overview ​

Projects are the main container for work items in a workspace.

The project object ​

Attributes ​

  • archive_in integer

    The archive in.

  • archived_at string (date-time)

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

  • close_in integer

    The close in.

  • cover_image string

    URL of the cover image.

  • cover_image_url string

    The cover image url.

  • created_at string (date-time)

    When the record was created.

  • created_by_id string (uuid)

    The user who created the record.

  • cycle_view boolean

    Whether cycle view.

  • default_assignee_id string (uuid)

    The related default assignee.

  • default_state_id string (uuid)

    The related default state.

  • description string

    Free-form description.

  • emoji string

    Emoji shown alongside the name.

  • estimate_id string (uuid)

    The related estimate.

  • external_id string

    Your system's identifier for this record, for sync and import correlation.

  • external_source string

    The system external_id came from, for example github or jira.

  • guest_view_all_features boolean

    Whether guest view all features.

  • icon_prop string

    The icon prop.

  • id string (uuid)

    Unique identifier.

  • identifier string

    Short project key used to prefix work item numbers, for example ENG in ENG-142.

  • intake_view boolean

    Whether intake view.

  • is_issue_type_enabled boolean

    Whether is issue type enabled.

  • is_time_tracking_enabled boolean

    Whether is time tracking enabled.

  • issue_views_view boolean

    Whether issue views view.

  • logo_props string

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

  • module_view boolean

    Whether module view.

  • name string

    Display name.

  • network integer

    Project visibility: 0 is private to members, 2 is visible to the whole workspace.

  • page_view boolean

    Whether page view.

  • priority string

    Urgency of the work item.

  • project_lead_id string (uuid)

    The related project lead.

  • start_date string (date-time)

    Planned start date, as YYYY-MM-DD.

  • state_id string (uuid)

    The related state.

  • target_date string (date-time)

    Planned due date, as YYYY-MM-DD.

  • timezone string

    IANA timezone name, for example America/New_York.

Response200
json
{
  "archive_in": 1,
  "archived_at": null,
  "close_in": 1,
  "cover_image": "https://example.com/cover.png",
  "cover_image_url": "https://example.com",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "cycle_view": false,
  "default_assignee_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "default_state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "description": "What this is for.",
  "emoji": "1f680",
  "estimate_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "external_id": null,
  "external_source": null,
  "guest_view_all_features": false,
  "icon_prop": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "identifier": "PROJ",
  "intake_view": false,
  "is_issue_type_enabled": false,
  "is_time_tracking_enabled": false,
  "issue_views_view": false,
  "logo_props": null,
  "module_view": false,
  "name": "Example name",
  "network": 0,
  "page_view": false,
  "priority": "high",
  "project_lead_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "start_date": "2026-01-12",
  "state_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "target_date": "2026-01-20",
  "timezone": "Africa/Abidjan"
}

Endpoints ​

MethodPathDescription
GET/api/v2/workspaces/{slug}/projects/List projects
GET/api/v2/workspaces/{slug}/projects/{pk}/summary/Get a project summary
GET/api/v2/workspaces/{slug}/projects/{pk}/Get a project
POST/api/v2/workspaces/{slug}/projects/Create a project
PATCH/api/v2/workspaces/{slug}/projects/{pk}/Update a project
DELETE/api/v2/workspaces/{slug}/projects/{pk}/Delete a project
POST/api/v2/workspaces/{slug}/projects/upsert/Upsert a project
POST/api/v2/workspaces/{slug}/projects/bulk-create/Bulk create projects
POST/api/v2/workspaces/{slug}/projects/bulk-update/Bulk update projects
POST/api/v2/workspaces/{slug}/projects/{pk}/archive/Archive a project
POST/api/v2/workspaces/{slug}/projects/{pk}/unarchive/Unarchive a project

Response shaping ​

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