Projects

Retrieve a project

Fetch one project by id.

get/workspaces/{workspace_slug}/projects/{project_id}/

Request

  • Base URL: https://api.plane.so/api/v1
  • URL: https://api.plane.so/api/v1/workspaces/{workspace_slug}/projects/{project_id}/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.plane.so/auth/o/authorize-app/, token URL https://api.plane.so/auth/o/token/; client credentials, token URL https://api.plane.so/auth/o/token/, scopes: projects:read)

Path parameters

workspace_slugstring required

Workspace identifier from the workspace URL. In https://app.plane.so/my-team/projects/ it is my-team.

project_idstring uuid required

The project the resource belongs to.

Response

The project.

idstring uuid required
namestring required
identifierstring required

Short prefix used in work item identifiers, e.g. ENG.

descriptionstring nullable
network0 | 2

0 private to members, 2 visible to the whole workspace.

project_leadstring uuid nullable
default_assigneestring uuid nullable
timezonestring
cycle_viewboolean
module_viewboolean
page_viewboolean
intake_viewboolean
is_time_tracking_enabledboolean
archived_atstring date-time nullable
created_atstring date-time
updated_atstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.